Welcome to Glitchy Games!

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Reference

glitchygames

Modules

glitchygames.api

Glitchygames plugin API.

glitchygames.assets

glitchygames.color

Color constants and palette helpers.

This module contains color constants and palette helpers.

Attributes
glitchygames.color.NES module-attribute
NES = 'nes'
glitchygames.color.SYSTEM module-attribute
SYSTEM = 'system'
glitchygames.color.VGA module-attribute
VGA = 'vga'
glitchygames.color.__all__ module-attribute
__all__ = ['NES', 'SYSTEM', 'VGA', 'Default']
glitchygames.color.YELLOW module-attribute
YELLOW = YELLOW
glitchygames.color.PURPLE module-attribute
PURPLE = PURPLE
glitchygames.color.BLUE module-attribute
BLUE = BLUE
glitchygames.color.GREEN module-attribute
GREEN = GREEN
glitchygames.color.WHITE module-attribute
WHITE = WHITE
glitchygames.color.BLACK module-attribute
BLACK = BLACK
glitchygames.color.BLACKLUCENT module-attribute
BLACKLUCENT = BLACKLUCENT
glitchygames.color.BLUELUCENT module-attribute
BLUELUCENT = BLUELUCENT
glitchygames.color.RED module-attribute
RED = RED
Classes
glitchygames.color.Default

Bases: ColorPalette

A default set of colors used for Glitchy Games Examples.

Attributes
glitchygames.color.Default.YELLOW instance-attribute
YELLOW = get_color(0)
glitchygames.color.Default.PURPLE instance-attribute
PURPLE = get_color(1)
glitchygames.color.Default.BLUE instance-attribute
BLUE = get_color(2)
glitchygames.color.Default.GREEN instance-attribute
GREEN = get_color(3)
glitchygames.color.Default.WHITE instance-attribute
WHITE = get_color(4)
glitchygames.color.Default.BLACK instance-attribute
BLACK = get_color(5)
glitchygames.color.Default.BLACKLUCENT instance-attribute
BLACKLUCENT = get_color(6)
glitchygames.color.Default.BLUELUCENT instance-attribute
BLUELUCENT = get_color(7)
glitchygames.color.Default.RED instance-attribute
RED = get_color(8)
Functions
glitchygames.color.Default.get_color
get_color(palette_index: int) -> tuple[int, int, int]

Returns PyGame Color from the palette at the specified index.

Parameters:
  • palette_index (int) –

    The index of the color to return.

Returns:
  • tuple[int, int, int]

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

glitchygames.color.Default.set_color
set_color(palette_index: int, new_color: tuple) -> None

Sets the indexed color to the new PyGame Color.

Parameters:
  • palette_index (int) –

    The index of the color to set.

  • new_color (tuple) –

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

Returns:
  • None

    None

glitchygames.color.Default.__init__
__init__() -> None

Create a default color palette object.

Returns:
  • None

    None

Modules
glitchygames.color.palette

GlitchyGames palette module.

palette: Manages the custom color palette file format used by the engine.

Attributes
glitchygames.color.palette.VGA module-attribute
VGA = 'vga'
glitchygames.color.palette.SYSTEM module-attribute
SYSTEM = 'system'
glitchygames.color.palette.NES module-attribute
NES = 'nes'
Classes
glitchygames.color.palette.ColorPalette

Manages color palette data for Glitchy Games.

Functions
glitchygames.color.palette.ColorPalette.__init__
__init__(colors: Optional(list | None) = None, filename: Optional(str, None) = None) -> None

Create a color palette object.

Parameters:
  • colors (Optional(list | None), default: None ) –

    A list of PyGame Colors. Default: None

  • filename (Optional(str, None), default: None ) –

    The name of the palette file to load. Default: None

glitchygames.color.palette.ColorPalette.get_color
get_color(palette_index: int) -> tuple[int, int, int]

Returns PyGame Color from the palette at the specified index.

Parameters:
  • palette_index (int) –

    The index of the color to return.

Returns:
  • tuple[int, int, int]

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

glitchygames.color.palette.ColorPalette.set_color
set_color(palette_index: int, new_color: tuple) -> None

Sets the indexed color to the new PyGame Color.

Parameters:
  • palette_index (int) –

    The index of the color to set.

  • new_color (tuple) –

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

Returns:
  • None

    None

glitchygames.color.palette.PaletteUtility

Utility class for working with Glitchy Games palettes.

Functions
glitchygames.color.palette.PaletteUtility.load_palette_from_config staticmethod
load_palette_from_config(config: dict) -> list

Load a palette from a ConfigParser object.

Parameters:
  • config (dict) –

    A ConfigParser object containing palette data.

Returns:
  • list

    A list of PyGame Colors in the format list[tuple[R: int, G: int, B: int]].

glitchygames.color.palette.PaletteUtility.load_palette_from_file staticmethod
load_palette_from_file(config_file_path: str) -> list

Load a palette from a GlitchyGames palette file.

Parameters:
  • config_file_path (str) –

    The path to the palette file to load.

Returns:
  • list

    A list of PyGame Colors in the format list[tuple[R: int, G: int, B: int]].

glitchygames.color.palette.PaletteUtility.write_palette_to_file staticmethod
write_palette_to_file(config_data: dict, output_file: str) -> None

Write a GlitchyGames palette to a file.

Parameters:
  • config_data (dict) –

    A ConfigParser object containing palette data.

  • output_file (str) –

    The path to the palette file to write.

Returns:
  • None

    None

glitchygames.color.palette.PaletteUtility.parse_rgb_data_in_file staticmethod
parse_rgb_data_in_file(rgb_data_file: str) -> list

Read RGB data from a file.

Parameters:
  • rgb_data_file (str) –

    The path to the file containing RGB data.

Returns:
  • list

    A list of PyGame Colors in the format list[tuple[R: int, G: int, B: int]].

glitchygames.color.palette.PaletteUtility.create_palette_data staticmethod
create_palette_data(colors: list) -> ConfigParser

Create a ConfigParser object containing palette data from a list of PyGame Colors.

Parameters:
  • colors (list) –

    A list of PyGame Colors in the format list[tuple[R: int, G: int, B: int]].

Returns:
  • ConfigParser

    A ConfigParser object containing palette data.

glitchygames.color.palette.Default

Bases: ColorPalette

A default set of colors used for Glitchy Games Examples.

Attributes
glitchygames.color.palette.Default.YELLOW instance-attribute
YELLOW = get_color(0)
glitchygames.color.palette.Default.PURPLE instance-attribute
PURPLE = get_color(1)
glitchygames.color.palette.Default.BLUE instance-attribute
BLUE = get_color(2)
glitchygames.color.palette.Default.GREEN instance-attribute
GREEN = get_color(3)
glitchygames.color.palette.Default.WHITE instance-attribute
WHITE = get_color(4)
glitchygames.color.palette.Default.BLACK instance-attribute
BLACK = get_color(5)
glitchygames.color.palette.Default.BLACKLUCENT instance-attribute
BLACKLUCENT = get_color(6)
glitchygames.color.palette.Default.BLUELUCENT instance-attribute
BLUELUCENT = get_color(7)
glitchygames.color.palette.Default.RED instance-attribute
RED = get_color(8)
Functions
glitchygames.color.palette.Default.get_color
get_color(palette_index: int) -> tuple[int, int, int]

Returns PyGame Color from the palette at the specified index.

Parameters:
  • palette_index (int) –

    The index of the color to return.

Returns:
  • tuple[int, int, int]

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

glitchygames.color.palette.Default.set_color
set_color(palette_index: int, new_color: tuple) -> None

Sets the indexed color to the new PyGame Color.

Parameters:
  • palette_index (int) –

    The index of the color to set.

  • new_color (tuple) –

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

Returns:
  • None

    None

glitchygames.color.palette.Default.__init__
__init__() -> None

Create a default color palette object.

Returns:
  • None

    None

glitchygames.color.palette.System

Bases: ColorPalette

A palette representing the 16 default system colors.

Attributes
glitchygames.color.palette.System.BLACK instance-attribute
BLACK = get_color(0)
glitchygames.color.palette.System.MAROON instance-attribute
MAROON = get_color(1)
glitchygames.color.palette.System.GREEN instance-attribute
GREEN = get_color(2)
glitchygames.color.palette.System.OLIVE instance-attribute
OLIVE = get_color(3)
glitchygames.color.palette.System.NAVY instance-attribute
NAVY = get_color(4)
glitchygames.color.palette.System.PURPLE instance-attribute
PURPLE = get_color(5)
glitchygames.color.palette.System.TEAL instance-attribute
TEAL = get_color(6)
glitchygames.color.palette.System.SILVER instance-attribute
SILVER = get_color(7)
glitchygames.color.palette.System.GREY instance-attribute
GREY = get_color(8)
glitchygames.color.palette.System.RED instance-attribute
RED = get_color(9)
glitchygames.color.palette.System.LIME instance-attribute
LIME = get_color(10)
glitchygames.color.palette.System.YELLOW instance-attribute
YELLOW = get_color(11)
glitchygames.color.palette.System.BLUE instance-attribute
BLUE = get_color(12)
glitchygames.color.palette.System.MAGENTA instance-attribute
MAGENTA = get_color(13)
glitchygames.color.palette.System.CYAN instance-attribute
CYAN = get_color(14)
glitchygames.color.palette.System.WHITE instance-attribute
WHITE = get_color(15)
Functions
glitchygames.color.palette.System.get_color
get_color(palette_index: int) -> tuple[int, int, int]

Returns PyGame Color from the palette at the specified index.

Parameters:
  • palette_index (int) –

    The index of the color to return.

Returns:
  • tuple[int, int, int]

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

glitchygames.color.palette.System.set_color
set_color(palette_index: int, new_color: tuple) -> None

Sets the indexed color to the new PyGame Color.

Parameters:
  • palette_index (int) –

    The index of the color to set.

  • new_color (tuple) –

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

Returns:
  • None

    None

glitchygames.color.palette.System.__init__
__init__() -> None

Create a system color palette object.

Returns:
  • None

    None

glitchygames.color.palette.Vga

Bases: ColorPalette

The 256 VGA color palette.

Functions
glitchygames.color.palette.Vga.get_color
get_color(palette_index: int) -> tuple[int, int, int]

Returns PyGame Color from the palette at the specified index.

Parameters:
  • palette_index (int) –

    The index of the color to return.

Returns:
  • tuple[int, int, int]

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

glitchygames.color.palette.Vga.set_color
set_color(palette_index: int, new_color: tuple) -> None

Sets the indexed color to the new PyGame Color.

Parameters:
  • palette_index (int) –

    The index of the color to set.

  • new_color (tuple) –

    A PyGame Color object in the format tuple[R: int, G: int, B: int]

Returns:
  • None

    None

glitchygames.color.palette.Vga.__init__
__init__() -> None

Create a VGA color palette object.

Returns:
  • None

    None

glitchygames.engine

Contains GameEngine and helper classes for building a game.

Attributes
glitchygames.engine.LOG module-attribute
LOG: Logger = getLogger('game.engine')
glitchygames.engine.PACKAGE_PATH module-attribute
PACKAGE_PATH: str = parent
glitchygames.engine.ASSET_PATH module-attribute
ASSET_PATH: str = parent / 'assets'
glitchygames.engine.TEST_MODE module-attribute
TEST_MODE = False
Classes
glitchygames.engine.GameManager

Bases: ResourceManager

Game event manager.

Attributes
glitchygames.engine.GameManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.engine.GameManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.engine.GameManager.proxies instance-attribute
proxies: list[GameProxy] = [GameProxy(game=game)]
Classes
glitchygames.engine.GameManager.GameProxy

Bases: ResourceManager

Game event proxy.

Attributes
glitchygames.engine.GameManager.GameProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.engine.GameManager.GameProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.engine.GameManager.GameProxy.game instance-attribute
game: object = get('game')
glitchygames.engine.GameManager.GameProxy.proxies instance-attribute
proxies = [game]
Functions
glitchygames.engine.GameManager.GameProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.engine.GameManager.GameProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.engine.GameManager.GameProxy.__init__
__init__(**kwargs) -> None

Initialize the game proxy.

Parameters:
  • **kwargs

    Keyword arguments.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_active_event
on_active_event(event: Event) -> None

Handle active event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_fps_event
on_fps_event(event: Event) -> None

Handle fps event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_game_event
on_game_event(event: Event) -> None

Handle game event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_menu_item_event
on_menu_item_event(event: Event) -> None

Handle menu item event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_user_event
on_user_event(event: Event) -> None

Handle user event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.engine.GameManager.GameProxy.on_quit_event
on_quit_event(event: Event) -> None

Handle quit event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

Functions
glitchygames.engine.GameManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.engine.GameManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.engine.GameManager.__init__
__init__(game: object = None) -> None

Initialize the game event manager.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.engine.GameManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add arguments to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    None

glitchygames.engine.GameEngine

Bases: EventManager

Glitchy Games' Game engine.

The game engine is responsible for initializing pygame and handling events. It also provides a number of helper methods for common tasks such as setting the screen resolution and setting the cursor.

Every Glitchy Game game inherits the GameEngine command line options, so you can add your own command line options by implementing the args() class method in your Scene class.

Attributes
glitchygames.engine.GameEngine.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.engine.GameEngine.proxies instance-attribute
proxies = [EventProxy(event_source=self)]
glitchygames.engine.GameEngine.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.engine.GameEngine.game class-attribute instance-attribute
game: object = None
glitchygames.engine.GameEngine.icon class-attribute instance-attribute
icon: Surface = load(Path(ASSET_PATH) / 'glitch.png')
glitchygames.engine.GameEngine.NAME class-attribute instance-attribute
NAME: Literal['Boilerplate Adventures'] = 'Boilerplate Adventures'
glitchygames.engine.GameEngine.VERSION class-attribute instance-attribute
VERSION: Literal['1.0'] = '1.0'
glitchygames.engine.GameEngine.OPTIONS class-attribute instance-attribute
OPTIONS: ClassVar = None
glitchygames.engine.GameEngine.LAST_EVENT_MISS class-attribute instance-attribute
LAST_EVENT_MISS: ClassVar = None
glitchygames.engine.GameEngine.MISSING_EVENTS class-attribute instance-attribute
MISSING_EVENTS: ClassVar = []
glitchygames.engine.GameEngine.UNIMPLEMENTED_EVENTS class-attribute instance-attribute
UNIMPLEMENTED_EVENTS: ClassVar = []
glitchygames.engine.GameEngine.USE_FASTEVENTS class-attribute instance-attribute
USE_FASTEVENTS: ClassVar = False
glitchygames.engine.GameEngine.EVENT_HANDLERS class-attribute instance-attribute
EVENT_HANDLERS: ClassVar = {}
glitchygames.engine.GameEngine.fps instance-attribute
fps: float = get('fps', 0.0)
glitchygames.engine.GameEngine.update_type instance-attribute
update_type = get('update_type')
glitchygames.engine.GameEngine.use_gfxdraw instance-attribute
use_gfxdraw = get('use_gfxdraw')
glitchygames.engine.GameEngine.windowed instance-attribute
windowed = get('windowed')
glitchygames.engine.GameEngine.fps_refresh_rate instance-attribute
fps_refresh_rate = get('fps_refresh_rate')
glitchygames.engine.GameEngine.pygame_version instance-attribute
pygame_version = {'major': 0, 'minor': 0, 'patch': 0}
glitchygames.engine.GameEngine.scene_manager instance-attribute
scene_manager: SceneManager = SceneManager()
glitchygames.engine.GameEngine.mode_flags instance-attribute
mode_flags: int = 0
glitchygames.engine.GameEngine.desired_resolution instance-attribute
desired_resolution: tuple[int, int] = suggested_resolution(desired_width, desired_height)
glitchygames.engine.GameEngine.screen_width property
screen_width: int

Get the screen width.

Returns:
  • int( int ) –

    The screen width.

glitchygames.engine.GameEngine.screen_height property
screen_height: int

Get the screen height.

Returns:
  • int( int ) –

    The screen height.

Classes
glitchygames.engine.GameEngine.EventProxy

Proxy for events.

Attributes
glitchygames.engine.GameEngine.EventProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.engine.GameEngine.EventProxy.proxies instance-attribute
proxies = []
glitchygames.engine.GameEngine.EventProxy.event_source instance-attribute
event_source = event_source
Functions
glitchygames.engine.GameEngine.EventProxy.__init__
__init__(event_source: object) -> None

Initialize the event proxy.

Parameters:
  • event_source (object) –

    The event source.

Returns:
  • None

    None

glitchygames.engine.GameEngine.EventProxy.unhandled_event
unhandled_event(*args, **kwargs) -> None

Handle unhandled events.

Parameters:
  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • None

    None

glitchygames.engine.GameEngine.EventProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Functions
glitchygames.engine.GameEngine.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.engine.GameEngine.__init__
__init__(game: object, icon: Surface | Path | str = None) -> None

Initialize the game engine.

Parameters:
  • game (object) –

    The game instance.

  • icon (Surface | Path | str, default: None ) –

    The game icon.

Returns:
  • None

    None

glitchygames.engine.GameEngine.initialize_display
initialize_display() -> None

Initialize the display.

Returns:
  • None

    None

glitchygames.engine.GameEngine.initialize_event_handlers
initialize_event_handlers() -> None

Initialize event handlers.

The engine calls this on your behalf.

Event subsystem bootstrapping

This gives us much faster event processing than doing a lookup every time an event comes in since we can just call the processing function directly.

It's not as fast as a raw pygame event loop, but since we layer richer event types on top of the pygame raw events, this gives us a nice balance of extensibility with performance.

Returns:
  • None

    None

glitchygames.engine.GameEngine.initialize_input_event_handlers
initialize_input_event_handlers() -> None

Initialize input event handlers.

The engine calls this on your behalf.

This initializes the input event handlers.

Returns:
  • None

    None

glitchygames.engine.GameEngine.__del__
__del__() -> None

Delete the game engine.

Returns:
  • None

    None

glitchygames.engine.GameEngine.print_system_info
print_system_info() -> None

Print system information.

Returns:
  • None

    None

glitchygames.engine.GameEngine.print_game_info
print_game_info() -> None

Print game information.

Returns:
  • None

    None

glitchygames.engine.GameEngine.suggested_resolution
suggested_resolution(desired_width: int = 0, desired_height: int = 0) -> tuple[int, int]

Suggest a resolution.

Parameters:
  • desired_width (int, default: 0 ) –

    The desired width.

  • desired_height (int, default: 0 ) –

    The desired height.

Returns:
  • tuple[int, int]

    tuple[int, int]: The suggested resolution.

glitchygames.engine.GameEngine.set_cursor classmethod
set_cursor(
    cursor: list[str], cursor_black: str = ".", cursor_white: str = "X", cursor_xor: str = "o"
) -> list[str]

Set the cursor.

Parameters:
  • cursor (list[str]) –

    The cursor.

  • cursor_black (str, default: '.' ) –

    The black cursor.

  • cursor_white (str, default: 'X' ) –

    The white cursor.

  • cursor_xor (str, default: 'o' ) –

    The xor cursor.

Returns:
  • list[str]

    list[str]: The cursor.

glitchygames.engine.GameEngine.initialize_system_icons
initialize_system_icons() -> None

Initialize system icons.

Returns:
  • None

    None

glitchygames.engine.GameEngine.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add Glitchy Games arguments to the argument parser.

All Glitchy Games will inherit these arguments.

Supported Arguments

-f, --target-fps --fps-refresh-rate -w, --windowed -r, --resolution --use-gfxdraw --update-type --video-driver

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    None

glitchygames.engine.GameEngine.start
start() -> None

Start the game engine.

Returns:
  • None

    None

glitchygames.engine.GameEngine.quit_game classmethod
quit_game() -> None

Quit the game.

Emits a pygame.event.Event(pygame.QUIT, {}) event.

Returns:
  • None

    None

glitchygames.engine.GameEngine.process_events
process_events() -> bool

Process events.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_audio_event
process_audio_event(event: Event) -> bool

Process an audio event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_controller_event
process_controller_event(event: Event) -> bool

Process a controller event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_drop_event
process_drop_event(event: Event) -> bool

Process a drop event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_touch_event
process_touch_event(event: Event) -> bool

Process a touch event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_midi_event
process_midi_event(event: Event) -> bool

Process a midi event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_mouse_event
process_mouse_event(event: Event) -> bool

Process a mouse event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_keyboard_event
process_keyboard_event(event: Event) -> bool

Process a keyboard event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_joystick_event
process_joystick_event(event: Event) -> bool

Process a joystick event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_text_event
process_text_event(event: Event) -> None

Process a text event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( None ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_window_focus_event
process_window_focus_event(event: Event) -> bool

Process a window focus event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( bool ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_window_event
process_window_event(event: Event) -> None

Process a window event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( None ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_game_event
process_game_event(event: Event) -> None

Process a game event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • bool( None ) –

    True if the event was handled, False otherwise.

glitchygames.engine.GameEngine.process_unimplemented_event
process_unimplemented_event(event: Event) -> None

Process an unimplemented event.

Parameters:
  • event (Event) –

    The event.

Returns:
  • None

    None

glitchygames.engine.GameEngine.post_game_event
post_game_event(event_subtype: EventType, event_data: dict) -> None

Post a game event.

Parameters:
  • event_subtype (EventType) –

    The event subtype.

  • event_data (dict) –

    The event data.

Returns:
  • None

    None

glitchygames.engine.GameEngine.suppress_event
suppress_event(*args, attr: str, **kwargs) -> None

Suppress an event.

Parameters:
  • *args

    The args.

  • attr (str) –

    The attribute.

  • **kwargs

    The kwargs.

Returns:
  • None

    None

glitchygames.engine.GameEngine.register_game_event
register_game_event(event_type: EventType, callback: Callable) -> None

Register a game event.

Parameters:
  • event_type (EventType) –

    The event type.

  • callback (Callable) –

    The callback.

Returns:
  • None

    None

glitchygames.engine.GameEngine.missing_event
missing_event(*args, **kwargs) -> None

Suppress unhandled on_*_event methods.

We only want to log this once per event type.

Parameters:
  • *args

    The args.

  • **kwargs

    The kwargs.

Returns:
  • None

    None

glitchygames.engine.GameEngine.__getattr__
__getattr__(attr: str) -> Callable

Suppress unhandled on_*_event methods.

If the attribute being looked up is not an on_*_event attribute, raise AttributeError as usual.

Parameters:
  • attr (str) –

    The attribute to proxy.

Returns:
  • Callable( Callable ) –

    The callable object.

Modules

glitchygames.events

Glitchy Games event module.

This module contains the event substrate for handling higher level events in the game engine.

Many events are 1:1 with pygame events, but some are synthesized. For example, a mouse drop event is a synthesized event that is triggered by a mouse button down event followed by a mouse motion event followed by a mouse button up event.

Attributes
glitchygames.events.LOG module-attribute
LOG: Logger = getLogger('game.events')
glitchygames.events.FPSEVENT module-attribute
FPSEVENT = USEREVENT + 1
glitchygames.events.GAMEEVENT module-attribute
GAMEEVENT = USEREVENT + 2
glitchygames.events.MENUEVENT module-attribute
MENUEVENT = USEREVENT + 3
glitchygames.events.AUDIO_EVENTS module-attribute
AUDIO_EVENTS = supported_events(like='AUDIO.*?')
glitchygames.events.CONTROLLER_EVENTS module-attribute
CONTROLLER_EVENTS = supported_events(like='CONTROLLER.*?')
glitchygames.events.DROP_EVENTS module-attribute
DROP_EVENTS = supported_events(like='DROP.*?')
glitchygames.events.TOUCH_EVENTS module-attribute
TOUCH_EVENTS = supported_events(like='(FINGER|MULTI).*?')
glitchygames.events.JOYSTICK_EVENTS module-attribute
JOYSTICK_EVENTS = supported_events(like='JOY.*?')
glitchygames.events.KEYBOARD_EVENTS module-attribute
KEYBOARD_EVENTS = supported_events(like='KEY.*?')
glitchygames.events.MIDI_EVENTS module-attribute
MIDI_EVENTS = supported_events(like='MIDI.*?')
glitchygames.events.MOUSE_EVENTS module-attribute
MOUSE_EVENTS = supported_events(like='MOUSE.*?')
glitchygames.events.TEXT_EVENTS module-attribute
TEXT_EVENTS = supported_events(like='TEXT.*?')
glitchygames.events.WINDOW_EVENTS module-attribute
WINDOW_EVENTS = supported_events(like='WINDOW.*?')
glitchygames.events.ALL_EVENTS module-attribute
ALL_EVENTS = supported_events()
glitchygames.events.GAME_EVENTS module-attribute
GAME_EVENTS = list(
    set(ALL_EVENTS)
    - set(AUDIO_EVENTS)
    - set(CONTROLLER_EVENTS)
    - set(DROP_EVENTS)
    - set(TOUCH_EVENTS)
    - set(JOYSTICK_EVENTS)
    - set(KEYBOARD_EVENTS)
    - set(MIDI_EVENTS)
    - set(MOUSE_EVENTS)
    - set(TEXT_EVENTS)
    - set(WINDOW_EVENTS)
)
Classes
glitchygames.events.ResourceManager

Singleton aggregator base class for event proxies.

A ResourceManager subclass will generally pass all requests through to its proxy object(s), however, for certain types of resources such as joysticks, the subclass will manage things itself. This architecture reduces code footprint, and allows maxium flexibility when needed, at the expense of a bit of abstraction.

Unless you're implementing a new pygame event manager, you probably don't need to worry about this.

Any subclass of ResourceManager will become a singleton class automatically. This ensures that there is only ever a single manager for any given resource.

For instance, a second instantiation of MouseManager would return the same MouseManager object that the GameEngine created to process mouse events with.

This behavior allows easy access to resource managers anywhere in the game without needing an explicit copy of the game object, althogh since GameEngine is also a subclass of EventManager, it too is a ResourceManager which can be gotten to from anywhere, since it's a singleton.

Attributes
glitchygames.events.ResourceManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.ResourceManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.ResourceManager.proxies instance-attribute
proxies = []
Functions
glitchygames.events.ResourceManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.ResourceManager.__init__
__init__(game: object) -> None

Initialize the resource manager.

Parameters:
  • game (object) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.ResourceManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.HashableEvent

Bases: dict

Attributes
glitchygames.events.HashableEvent.type instance-attribute
type = type
glitchygames.events.HashableEvent.__hash instance-attribute
__hash = hash((type, tuple(keys())))
glitchygames.events.HashableEvent.dict property
dict
Functions
glitchygames.events.HashableEvent.__init__
__init__(type, *args, **attributes)
glitchygames.events.HashableEvent.__setitem__
__setitem__(key, item)
glitchygames.events.HashableEvent.__getitem__
__getitem__(key)
glitchygames.events.HashableEvent.__len__
__len__()
glitchygames.events.HashableEvent.__delitem__
__delitem__(key)
glitchygames.events.HashableEvent.clear
clear()
glitchygames.events.HashableEvent.copy
copy()
glitchygames.events.HashableEvent.has_key
has_key(k)
glitchygames.events.HashableEvent.update
update(*args, **kwargs)
glitchygames.events.HashableEvent.keys
keys()
glitchygames.events.HashableEvent.values
values()
glitchygames.events.HashableEvent.__hash__
__hash__()
glitchygames.events.HashableEvent.__eq__
__eq__(other)
glitchygames.events.HashableEvent.__ne__
__ne__(other)
glitchygames.events.HashableEvent.__repr__
__repr__()
glitchygames.events.HashableEvent.__str__
__str__()
glitchygames.events.HashableEvent.__copy__
__copy__()
glitchygames.events.HashableEvent.__deepcopy__
__deepcopy__(memo)
glitchygames.events.HashableEvent.__reduce__
__reduce__()
glitchygames.events.HashableEvent.__setstate__
__setstate__(state)
glitchygames.events.EventInterface

Abstract base class for event interfaces.

Functions
glitchygames.events.EventInterface.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.AudioEvents

Bases: EventInterface

Mixin for audio events.

Functions
glitchygames.events.AudioEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.AudioEvents.on_audio_device_added_event abstractmethod
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.AudioEvents.on_audio_device_removed_event abstractmethod
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.AudioEventStubs

Bases: AudioEvents

Mixin for audio events.

Functions
glitchygames.events.AudioEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.AudioEventStubs.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.AudioEventStubs.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents

Bases: EventInterface

Mixin for controller events.

Functions
glitchygames.events.ControllerEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.ControllerEvents.on_controller_axis_motion_event abstractmethod
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_button_down_event abstractmethod
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_button_up_event abstractmethod
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_device_added_event abstractmethod
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_device_remapped_event abstractmethod
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_device_removed_event abstractmethod
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_touchpad_down_event abstractmethod
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_touchpad_motion_event abstractmethod
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEvents.on_controller_touchpad_up_event abstractmethod
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs

Bases: ControllerEvents

Mixin for controller events.

Functions
glitchygames.events.ControllerEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.ControllerEventStubs.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_button_down_event cached
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_button_up_event cached
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.ControllerEventStubs.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.DropEvents

Bases: EventInterface

Mixin for drop events.

Functions
glitchygames.events.DropEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.DropEvents.on_drop_begin_event abstractmethod
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEvents.on_drop_file_event abstractmethod
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEvents.on_drop_text_event abstractmethod
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEvents.on_drop_complete_event abstractmethod
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEventStubs

Bases: EventInterface

Mixin for drop events.

Functions
glitchygames.events.DropEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.DropEventStubs.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEventStubs.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEventStubs.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.DropEventStubs.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEvents

Bases: EventInterface

Mixin for touch events.

Functions
glitchygames.events.TouchEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.TouchEvents.on_touch_down_event abstractmethod
on_touch_down_event(event: Event) -> None

Handle finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEvents.on_touch_motion_event abstractmethod
on_touch_motion_event(event: Event) -> None

Handle finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEvents.on_touch_up_event abstractmethod
on_touch_up_event(event: Event) -> None

Handle finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEvents.on_multi_touch_down_event abstractmethod
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEvents.on_multi_touch_motion_event abstractmethod
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEvents.on_multi_touch_up_event abstractmethod
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEventStubs

Bases: EventInterface

Mixin for touch events.

Functions
glitchygames.events.TouchEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.TouchEventStubs.on_touch_down_event cached
on_touch_down_event(event: Event) -> None

Handle finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEventStubs.on_touch_motion_event cached
on_touch_motion_event(event: Event) -> None

Handle finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEventStubs.on_touch_up_event cached
on_touch_up_event(event: Event) -> None

Handle finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEventStubs.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEventStubs.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.TouchEventStubs.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.GameEvents

Bases: EventInterface

Mixin for glitchy game events.

This includes built-ins like QUIT, and synthesized events like FPS and GAME events.

It's sort of a catch-all for event types that didn't have a good home otherwise.

Functions
glitchygames.events.GameEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.GameEvents.on_active_event abstractmethod
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_fps_event abstractmethod
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_game_event abstractmethod
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_menu_item_event abstractmethod
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_sys_wm_event abstractmethod
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_user_event abstractmethod
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_video_expose_event abstractmethod
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_video_resize_event abstractmethod
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEvents.on_quit_event abstractmethod
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs

Bases: EventInterface

Mixin for glitchy game events.

This includes built-ins like QUIT, and synthesized events like FPS and GAME events.

It's sort of a catch-all for event types that didn't have a good home otherwise.

Functions
glitchygames.events.GameEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.GameEventStubs.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_fps_event cached
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_sys_wm_event cached
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_user_event cached
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_video_expose_event cached
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_video_resize_event cached
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.GameEventStubs.on_quit_event cached
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.FontEvents

Bases: EventInterface

Mixin for font events.

Functions
glitchygames.events.FontEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.FontEvents.on_font_changed_event abstractmethod
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.FontEventStubs

Bases: EventInterface

Mixin for font events.

Functions
glitchygames.events.FontEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.FontEventStubs.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.KeyboardEvents

Bases: EventInterface

Mixin for keyboard events.

glitchygames.events.KeyboardEventStubs

Bases: EventInterface

Mixin for keyboard events.

Functions
glitchygames.events.KeyboardEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.KeyboardEventStubs.on_key_down_event cached
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.KeyboardEventStubs.on_key_up_event cached
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.KeyboardEventStubs.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.events.KeyboardEventStubs.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.events.JoystickEvents

Bases: EventInterface

Mixin for joystick events.

Functions
glitchygames.events.JoystickEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.JoystickEvents.on_joy_axis_motion_event abstractmethod
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEvents.on_joy_button_down_event abstractmethod
on_joy_button_down_event(event: Event) -> None

Handle joystick button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEvents.on_joy_button_up_event abstractmethod
on_joy_button_up_event(event: Event) -> None

Handle joystick button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEvents.on_joy_hat_motion_event abstractmethod
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEvents.on_joy_ball_motion_event abstractmethod
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEvents.on_joy_device_added_event abstractmethod
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEvents.on_joy_device_removed_event abstractmethod
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs

Bases: EventInterface

Mixin for joystick events.

Functions
glitchygames.events.JoystickEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.JoystickEventStubs.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs.on_joy_button_down_event cached
on_joy_button_down_event(event: Event) -> None

Handle joystick button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs.on_joy_button_up_event cached
on_joy_button_up_event(event: Event) -> None

Handle joystick button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.JoystickEventStubs.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MidiEvents

Bases: EventInterface

Mixin for midi events.

glitchygames.events.MidiEventStubs

Bases: EventInterface

Mixin for midi events.

glitchygames.events.MouseEvents

Bases: EventInterface

Mixin for mouse events.

Functions
glitchygames.events.MouseEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.MouseEvents.on_mouse_motion_event abstractmethod
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_drag_event abstractmethod
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_drop_event abstractmethod
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_left_mouse_drag_event abstractmethod
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_left_mouse_drop_event abstractmethod
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_middle_mouse_drag_event abstractmethod
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_middle_mouse_drop_event abstractmethod
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_right_mouse_drag_event abstractmethod
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_right_mouse_drop_event abstractmethod
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_focus_event abstractmethod
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_unfocus_event abstractmethod
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_button_up_event abstractmethod
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_left_mouse_button_up_event abstractmethod
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_middle_mouse_button_up_event abstractmethod
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_right_mouse_button_up_event abstractmethod
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_button_down_event abstractmethod
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_left_mouse_button_down_event abstractmethod
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_middle_mouse_button_down_event abstractmethod
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_right_mouse_button_down_event abstractmethod
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_scroll_down_event abstractmethod
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_scroll_up_event abstractmethod
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEvents.on_mouse_wheel_event abstractmethod
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs

Bases: EventInterface

Mixin for mouse events.

Functions
glitchygames.events.MouseEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.MouseEventStubs.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_drag_event cached
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_drop_event cached
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_left_mouse_drag_event cached
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_left_mouse_drop_event cached
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_middle_mouse_drag_event cached
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_middle_mouse_drop_event cached
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_right_mouse_drag_event cached
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_right_mouse_drop_event cached
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_left_mouse_button_up_event cached
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_middle_mouse_button_up_event cached
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_right_mouse_button_up_event cached
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_left_mouse_button_down_event cached
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_middle_mouse_button_down_event cached
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_right_mouse_button_down_event cached
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.MouseEventStubs.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.TextEvents

Bases: EventInterface

Mixin for text events.

Functions
glitchygames.events.TextEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.TextEvents.on_text_editing_event abstractmethod
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.TextEvents.on_text_input_event abstractmethod
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.TextEventStubs

Bases: EventInterface

Mixin for text events.

Functions
glitchygames.events.TextEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.TextEventStubs.on_text_editing_event cached
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.TextEventStubs.on_text_input_event cached
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents

Bases: EventInterface

Mixin for window events.

Functions
glitchygames.events.WindowEvents.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.WindowEvents.on_window_close_event abstractmethod
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_enter_event abstractmethod
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_exposed_event abstractmethod
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_focus_gained_event abstractmethod
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_focus_lost_event abstractmethod
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_hidden_event abstractmethod
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_hit_test_event abstractmethod
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_leave_event abstractmethod
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_maximized_event abstractmethod
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_minimized_event abstractmethod
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_moved_event abstractmethod
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_resized_event abstractmethod
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_restored_event abstractmethod
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_shown_event abstractmethod
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_size_changed_event abstractmethod
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEvents.on_window_take_focus_event abstractmethod
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs

Bases: EventInterface

Mixin for window events.

Functions
glitchygames.events.WindowEventStubs.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.WindowEventStubs.on_window_close_event cached
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_enter_event cached
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_exposed_event cached
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_focus_gained_event cached
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_focus_lost_event cached
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_hidden_event cached
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_hit_test_event cached
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_leave_event cached
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_maximized_event cached
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_minimized_event cached
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_moved_event cached
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_resized_event cached
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_restored_event cached
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_shown_event cached
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_size_changed_event cached
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.WindowEventStubs.on_window_take_focus_event cached
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.EventManager

Bases: ResourceManager

Root event manager.

Attributes
glitchygames.events.EventManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.EventManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.EventManager.proxies instance-attribute
proxies = [EventProxy(event_source=self)]
Classes
glitchygames.events.EventManager.EventProxy

Proxy for events.

Attributes
glitchygames.events.EventManager.EventProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.EventManager.EventProxy.proxies instance-attribute
proxies = []
glitchygames.events.EventManager.EventProxy.event_source instance-attribute
event_source = event_source
Functions
glitchygames.events.EventManager.EventProxy.__init__
__init__(event_source: object) -> None

Initialize the event proxy.

Parameters:
  • event_source (object) –

    The event source.

Returns:
  • None

    None

glitchygames.events.EventManager.EventProxy.unhandled_event
unhandled_event(*args, **kwargs) -> None

Handle unhandled events.

Parameters:
  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • None

    None

glitchygames.events.EventManager.EventProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Functions
glitchygames.events.EventManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.EventManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.EventManager.__init__
__init__(game: object = None) -> None

Initialize the event manager.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

Functions
glitchygames.events.supported_events
supported_events(like: str = '.*') -> list

Return a list of supported events.

This method is crucial for allowing the game engine to support both older versions of pygame and newer versions. It allows us to enumerate supported pygame events and initialize them dynamically.

This ensures that the game engine will work with many versions of pygame.

We enumerate all pygame event IDs and then use the pygame.event.event_name() method to get the event name. We then use a regular expression to match the event name against the like parameter.

Parameters:
  • like (str, default: '.*' ) –

    A regular expression to match against the event names.

Returns:
  • list

    A list of pygame events whose names match the regular expression.

glitchygames.events.dump_cache_info
dump_cache_info(func, *args, **kwargs)
glitchygames.events.unhandled_event cached
unhandled_event(game, event, *args, **kwargs) -> NoReturn

Handle unhandled events.

This method is called when an event is not handled by any of the event handlers.

This is helpful for us to debug events that we haven't implemented yet.

Parameters:
  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • NoReturn

    None

Raises:
  • AttributeError

    If the event is not handled.

Modules
glitchygames.events.audio

Audio.

This is a simple audio manager that can be used to manage audio.

Attributes
glitchygames.events.audio.log module-attribute
log = getLogger('game.audio')
Classes
glitchygames.events.audio.AudioManager

Bases: ResourceManager

Manage pygame audio events.

Attributes
glitchygames.events.audio.AudioManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.audio.AudioManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.audio.AudioManager.proxies instance-attribute
proxies = [AudioProxy(game=game)]
Classes
glitchygames.events.audio.AudioManager.AudioProxy

Bases: AudioEvents, ResourceManager

Pygame audio event proxy.

Attributes
glitchygames.events.audio.AudioManager.AudioProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.audio.AudioManager.AudioProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.audio.AudioManager.AudioProxy.game instance-attribute
game = game
glitchygames.events.audio.AudioManager.AudioProxy.proxies instance-attribute
proxies = [game, mixer]
Functions
glitchygames.events.audio.AudioManager.AudioProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.audio.AudioManager.AudioProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.audio.AudioManager.AudioProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.audio.AudioManager.AudioProxy.__init__
__init__(game: object = None) -> None

Initialize the audio proxy.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.audio.AudioManager.AudioProxy.on_audio_device_added_event
on_audio_device_added_event(event: Event) -> None

Handle audio device added event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.audio.AudioManager.AudioProxy.on_audio_device_removed_event
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

Functions
glitchygames.events.audio.AudioManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.audio.AudioManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.audio.AudioManager.__init__
__init__(game: object = None) -> None

Initialize the audio manager.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.audio.AudioManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add arguments to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    The argument parser.

glitchygames.events.controller

Controller Events.

This is a simple controller event class that can be used to handle controller events.

Attributes
glitchygames.events.controller.LOG module-attribute
LOG: Logger = getLogger('game.controllers')
Classes
glitchygames.events.controller.ControllerManager

Bases: ControllerEvents, ResourceManager

Manage controller events.

Attributes
glitchygames.events.controller.ControllerManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.controller.ControllerManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.controller.ControllerManager.controllers instance-attribute
controllers = {}
glitchygames.events.controller.ControllerManager.game instance-attribute
game = game
glitchygames.events.controller.ControllerManager.proxies instance-attribute
proxies = [game]
Classes
glitchygames.events.controller.ControllerManager.ControllerProxy

Bases: ControllerEvents, ResourceManager

Proxy class for controller events.

Attributes
glitchygames.events.controller.ControllerManager.ControllerProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.controller.ControllerManager.ControllerProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.controller.ControllerManager.ControllerProxy.AXIS class-attribute instance-attribute
AXIS: ClassVar = [
    CONTROLLER_AXIS_LEFTX,
    CONTROLLER_AXIS_LEFTY,
    CONTROLLER_AXIS_RIGHTX,
    CONTROLLER_AXIS_RIGHTY,
    CONTROLLER_AXIS_TRIGGERLEFT,
    CONTROLLER_AXIS_TRIGGERRIGHT,
]
glitchygames.events.controller.ControllerManager.ControllerProxy.BUTTONS class-attribute instance-attribute
BUTTONS: ClassVar = [
    CONTROLLER_BUTTON_A,
    CONTROLLER_BUTTON_B,
    CONTROLLER_BUTTON_X,
    CONTROLLER_BUTTON_Y,
    CONTROLLER_BUTTON_DPAD_UP,
    CONTROLLER_BUTTON_DPAD_DOWN,
    CONTROLLER_BUTTON_DPAD_LEFT,
    CONTROLLER_BUTTON_DPAD_RIGHT,
    CONTROLLER_BUTTON_LEFTSHOULDER,
    CONTROLLER_BUTTON_RIGHTSHOULDER,
    CONTROLLER_BUTTON_LEFTSTICK,
    CONTROLLER_BUTTON_RIGHTSTICK,
    CONTROLLER_BUTTON_BACK,
    CONTROLLER_BUTTON_GUIDE,
    CONTROLLER_BUTTON_START,
]
glitchygames.events.controller.ControllerManager.ControllerProxy.controller instance-attribute
controller = Controller(_id)
glitchygames.events.controller.ControllerManager.ControllerProxy.game instance-attribute
game = game
glitchygames.events.controller.ControllerManager.ControllerProxy.proxies instance-attribute
proxies = [game, controller]
Functions
glitchygames.events.controller.ControllerManager.ControllerProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.controller.ControllerManager.ControllerProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.controller.ControllerManager.ControllerProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.controller.ControllerManager.ControllerProxy.__init__
__init__(game: object = None, controller_id: int = -1) -> None

Initialize the controller proxy.

Parameters:
  • game (object, default: None ) –

    The game object.

  • controller_id (int, default: -1 ) –

    The controller id.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_axis_motion_event
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_device_added_event
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_device_remapped_event
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_device_removed_event
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_touchpad_down_event
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_touchpad_motion_event
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.on_controller_touchpad_up_event
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.ControllerProxy.__str__
__str__() -> LiteralString

Return a string representation of the controller.

Returns:
  • str( LiteralString ) –

    A string representation of the controller.

glitchygames.events.controller.ControllerManager.ControllerProxy.__repr__
__repr__() -> str

Return a string representation of the controller object.

Returns:
  • str( str ) –

    A string representation of the controller object.

Functions
glitchygames.events.controller.ControllerManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.controller.ControllerManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.controller.ControllerManager.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.controller.ControllerManager.__init__
__init__(game: object = None) -> None

Initialize the ControllerManager.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add controller options to the parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    argparse.ArgumentParser: The argument parser.

glitchygames.events.controller.ControllerManager.on_controller_axis_motion_event
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_device_added_event
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_device_remapped_event
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_device_removed_event
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_touchpad_down_event
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_touchpad_motion_event
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.controller.ControllerManager.on_controller_touchpad_up_event
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.drop

Drop Events.

This is a simple drop event class that can be used to handle drag & drop events.

Attributes
glitchygames.events.drop.log module-attribute
log = getLogger('game.events.drop_events')
Classes
glitchygames.events.drop.DropManager

Bases: ResourceManager

Manage drop events.

Attributes
glitchygames.events.drop.DropManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.drop.DropManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.drop.DropManager.proxies instance-attribute
proxies = [DropProxy(game=game)]
Classes
glitchygames.events.drop.DropManager.DropProxy

Bases: DropEvents, ResourceManager

Proxy class for drop events.

Attributes
glitchygames.events.drop.DropManager.DropProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.drop.DropManager.DropProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.drop.DropManager.DropProxy.game instance-attribute
game = game
glitchygames.events.drop.DropManager.DropProxy.proxies instance-attribute
proxies = [game]
Functions
glitchygames.events.drop.DropManager.DropProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.drop.DropManager.DropProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.drop.DropManager.DropProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.drop.DropManager.DropProxy.__init__
__init__(game: object = None) -> None

Initialize the drop proxy.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.drop.DropManager.DropProxy.on_drop_begin_event
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.drop.DropManager.DropProxy.on_drop_complete_event
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.drop.DropManager.DropProxy.on_drop_file_event
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.events.drop.DropManager.DropProxy.on_drop_text_event
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

Functions
glitchygames.events.drop.DropManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.drop.DropManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.drop.DropManager.__init__
__init__(game: object = None) -> None

Initialize the drop manager.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.drop.DropManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add arguments to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    The argument parser.

glitchygames.events.joystick

Joystick Event Manager.

Attributes
glitchygames.events.joystick.LOG module-attribute
LOG = getLogger('game.joysticks')
Classes
glitchygames.events.joystick.JoystickManager

Bases: JoystickEvents, ResourceManager

Manage joystick events.

Attributes
glitchygames.events.joystick.JoystickManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.joystick.JoystickManager.log class-attribute instance-attribute
log = LOG
glitchygames.events.joystick.JoystickManager.joysticks instance-attribute
joysticks = {}
glitchygames.events.joystick.JoystickManager.game instance-attribute
game = game
glitchygames.events.joystick.JoystickManager.proxies instance-attribute
proxies = [game]
Classes
glitchygames.events.joystick.JoystickManager.JoystickProxy

Bases: JoystickEvents, ResourceManager

Joystick event proxy.

Attributes
glitchygames.events.joystick.JoystickManager.JoystickProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.joystick.JoystickManager.JoystickProxy.log class-attribute instance-attribute
log = LOG
glitchygames.events.joystick.JoystickManager.JoystickProxy.joystick instance-attribute
joystick = Joystick(_id)
glitchygames.events.joystick.JoystickManager.JoystickProxy.game instance-attribute
game = game
glitchygames.events.joystick.JoystickManager.JoystickProxy.proxies instance-attribute
proxies = [game, joystick]
Functions
glitchygames.events.joystick.JoystickManager.JoystickProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.joystick.JoystickManager.JoystickProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.joystick.JoystickManager.JoystickProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.joystick.JoystickManager.JoystickProxy.__init__
__init__(game: object = None, joystick_id: int = -1) -> None

Initialize the joystick event proxy.

Parameters:
  • game (object, default: None ) –

    The game object.

  • joystick_id (int, default: -1 ) –

    The joystick id.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joystick button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joystick button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_device_added_event
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.on_joy_device_removed_event
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.JoystickProxy.get_name
get_name() -> str

Get the joystick name.

Returns:
  • str( str ) –

    The joystick name.

glitchygames.events.joystick.JoystickManager.JoystickProxy.get_init
get_init() -> bool

Get the joystick init status.

Returns:
  • bool( bool ) –

    The joystick init status.

glitchygames.events.joystick.JoystickManager.JoystickProxy.get_numaxes
get_numaxes() -> int

Get the number of axes.

Returns:
  • int( int ) –

    The number of axes.

glitchygames.events.joystick.JoystickManager.JoystickProxy.get_numballs
get_numballs() -> int

Get the number of trackballs.

Returns:
  • int( int ) –

    The number of trackballs.

glitchygames.events.joystick.JoystickManager.JoystickProxy.get_numbuttons
get_numbuttons() -> int

Get the number of buttons.

Returns:
  • int( int ) –

    The number of buttons.

glitchygames.events.joystick.JoystickManager.JoystickProxy.get_numhats
get_numhats() -> int

Get the number of hats.

Returns:
  • int( int ) –

    The number of hats.

glitchygames.events.joystick.JoystickManager.JoystickProxy.__str__
__str__() -> str

Get the joystick info.

Returns:
  • str( str ) –

    The joystick info.

glitchygames.events.joystick.JoystickManager.JoystickProxy.__repr__
__repr__() -> str

Get the joystick representation.

Returns:
  • str( str ) –

    The joystick representation.

Functions
glitchygames.events.joystick.JoystickManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.joystick.JoystickManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.joystick.JoystickManager.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.joystick.JoystickManager.__init__
__init__(game: object = None) -> None

Initialize the joystick event manager.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add joystick-specific arguments to the global parser.

This class method will get called automatically by the GameEngine class.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    argparse.ArgumentParser

glitchygames.events.joystick.JoystickManager.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joystick button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joystick button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.on_joy_device_added_event
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.joystick.JoystickManager.on_joy_device_removed_event
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.keyboard

Keyboard Event Manager.

Attributes
glitchygames.events.keyboard.log module-attribute
log = getLogger('game.keyboard')
Classes
glitchygames.events.keyboard.KeyboardManager

Bases: ResourceManager

Manage keyboard events.

Attributes
glitchygames.events.keyboard.KeyboardManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.keyboard.KeyboardManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.keyboard.KeyboardManager.proxies instance-attribute
proxies = [KeyboardProxy(game=game)]
Classes
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy

Bases: KeyboardEvents, ResourceManager

Keyboard event proxy.

Attributes
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.keys instance-attribute
keys = {}
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.game instance-attribute
game = game
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.proxies instance-attribute
proxies = [game, key]
Functions
glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.__init__
__init__(game: object = None) -> None

Initialize the keyboard event proxy.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.on_key_down_event
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.on_key_chord_down_event
on_key_chord_down_event(event: Event) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys_down (list) –

    The keys that are currently down.

Returns:
  • None

    None

glitchygames.events.keyboard.KeyboardManager.KeyboardProxy.on_key_chord_up_event
on_key_chord_up_event(event: Event) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.events.keyboard.KeyboardManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.keyboard.KeyboardManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.keyboard.KeyboardManager.__init__
__init__(game: object = None) -> None

Initialize the keyboard event manager.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.keyboard.KeyboardManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add keyboard-specific arguments to the global parser.

This class method will get called automatically by the GameEngine class.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    argparse.ArgumentParser

glitchygames.events.midi

Midi Event Manager.

Attributes
glitchygames.events.midi.log module-attribute
log = getLogger('game.midi')
Classes
glitchygames.events.midi.MidiManager

Bases: ResourceManager

Manage midi events.

Attributes
glitchygames.events.midi.MidiManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.midi.MidiManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.midi.MidiManager.proxies instance-attribute
proxies = []
Functions
glitchygames.events.midi.MidiManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.midi.MidiManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.midi.MidiManager.__init__
__init__(game: object = None) -> None

Initialize the midi event manager.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.midi.MidiManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add midi-specific arguments to the global parser.

This class method will get called automatically by the GameEngine class.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    argparse.ArgumentParser

glitchygames.events.mouse

Mouse manager.

Attributes
glitchygames.events.mouse.LOG module-attribute
LOG = getLogger('game.mouse')
glitchygames.events.mouse.MOUSE_BUTTON_LEFT module-attribute
MOUSE_BUTTON_LEFT = 1
glitchygames.events.mouse.MOUSE_BUTTON_WHEEL module-attribute
MOUSE_BUTTON_WHEEL = 2
glitchygames.events.mouse.MOUSE_BUTTON_RIGHT module-attribute
MOUSE_BUTTON_RIGHT = 3
glitchygames.events.mouse.MOUSE_WHEEL_SCROLL_UP module-attribute
MOUSE_WHEEL_SCROLL_UP = 4
glitchygames.events.mouse.MOUSE_WHEEL_SCROLL_DOWN module-attribute
MOUSE_WHEEL_SCROLL_DOWN = 5
Classes
glitchygames.events.mouse.MouseManager

Bases: ResourceManager

Mouse manager event handler.

Attributes
glitchygames.events.mouse.MouseManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.mouse.MouseManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.mouse.MouseManager.proxies instance-attribute
proxies = [MouseProxy(game=game)]
Classes
glitchygames.events.mouse.MouseManager.MouseProxy

Bases: MouseEvents, ResourceManager

Mouse manager event proxy.

Attributes
glitchygames.events.mouse.MouseManager.MouseProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.mouse.MouseManager.MouseProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.mouse.MouseManager.MouseProxy.mouse_state instance-attribute
mouse_state = {}
glitchygames.events.mouse.MouseManager.MouseProxy.mouse_dragging instance-attribute
mouse_dragging = False
glitchygames.events.mouse.MouseManager.MouseProxy.mouse_dropping instance-attribute
mouse_dropping = False
glitchygames.events.mouse.MouseManager.MouseProxy.current_focus instance-attribute
current_focus = None
glitchygames.events.mouse.MouseManager.MouseProxy.previous_focus instance-attribute
previous_focus = None
glitchygames.events.mouse.MouseManager.MouseProxy.focus_locked instance-attribute
focus_locked = False
glitchygames.events.mouse.MouseManager.MouseProxy.game instance-attribute
game = game
glitchygames.events.mouse.MouseManager.MouseProxy.proxies instance-attribute
proxies = [game, mouse]
Functions
glitchygames.events.mouse.MouseManager.MouseProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.mouse.MouseManager.MouseProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.mouse.MouseManager.MouseProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.mouse.MouseManager.MouseProxy.__init__
__init__(game: object = None) -> None

Initialize the mouse manager event proxy.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle the mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: Event) -> None

Handle the mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: Event) -> None

Handle the mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: Event) -> None

Handle the left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: Event) -> None

Handle the left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: Event) -> None

Handle the middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: Event) -> None

Handle the middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: Event) -> None

Handle the right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: Event) -> None

Handle the right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (Event) –

    The triggering event.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_focus_event
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle the mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object entering focus.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle the mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object leaving focus.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle the mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle the left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle the middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle the right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle the mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle the left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle the middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle the right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle the mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle the mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.MouseProxy.on_mouse_wheel_event
on_mouse_wheel_event(event: Event) -> None

Handle the mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.events.mouse.MouseManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.mouse.MouseManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.mouse.MouseManager.__init__
__init__(game: object = None) -> None

Initialize the mouse manager.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.mouse.MouseManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add arguments to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    None

glitchygames.events.mouse.MousePointer

Mouse pointer sprite.

Attributes
glitchygames.events.mouse.MousePointer.pos instance-attribute
pos = pos
glitchygames.events.mouse.MousePointer.size instance-attribute
size = size
glitchygames.events.mouse.MousePointer.rect instance-attribute
rect = Rect(pos, size)
glitchygames.events.mouse.MousePointer.x property writable
x: int

Get the x coordinate of the mouse pointer.

Returns:
  • int

    int

glitchygames.events.mouse.MousePointer.y property writable
y: int

Get the y coordinate of the mouse pointer.

Returns:
  • int

    int

Functions
glitchygames.events.mouse.MousePointer.__init__
__init__(pos: tuple, size: tuple = (1, 1)) -> None

Initialize the mouse pointer sprite.

Parameters:
  • pos (tuple) –

    The position of the mouse pointer.

  • size (tuple, default: (1, 1) ) –

    The size of the mouse pointer.

Returns:
  • None

    None

Functions
glitchygames.events.mouse.collided_sprites
collided_sprites(scene: object, event: Event, index: int | None = None) -> list

Get the list of collided sprites.

Parameters:
  • scene (object) –

    The scene to check.

  • event (Event) –

    The event to check.

  • index (int, default: None ) –

    The index of the sprite to return.

Returns:
  • list( list ) –

    The list of collided sprites.

glitchygames.events.touch

Touch Event Manager.

Classes
glitchygames.events.touch.TouchManager

Bases: ResourceManager

Touch event manager.

Attributes
glitchygames.events.touch.TouchManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.touch.TouchManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.touch.TouchManager.proxies instance-attribute
proxies = [TouchProxy(game=game)]
Classes
glitchygames.events.touch.TouchManager.TouchProxy

Bases: TouchEvents, ResourceManager

Touch event proxy.

Attributes
glitchygames.events.touch.TouchManager.TouchProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.touch.TouchManager.TouchProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.touch.TouchManager.TouchProxy.fingers instance-attribute
fingers: dict = {}
glitchygames.events.touch.TouchManager.TouchProxy.game instance-attribute
game: object = game
glitchygames.events.touch.TouchManager.TouchProxy.proxies instance-attribute
proxies: list = [game, touch]
Functions
glitchygames.events.touch.TouchManager.TouchProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.touch.TouchManager.TouchProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.touch.TouchManager.TouchProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.touch.TouchManager.TouchProxy.__init__
__init__(game: object = None) -> None

Initialize the finger event proxy.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.touch.TouchManager.TouchProxy.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle finger down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.touch.TouchManager.TouchProxy.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle finger motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.touch.TouchManager.TouchProxy.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle finger up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.touch.TouchManager.TouchProxy.on_multi_touch_down_event
on_multi_touch_down_event(event: Event) -> None

Handle multi-touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.touch.TouchManager.TouchProxy.on_multi_touch_motion_event
on_multi_touch_motion_event(event: Event) -> None

Handle multi-touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.touch.TouchManager.TouchProxy.on_multi_touch_up_event
on_multi_touch_up_event(event: Event) -> None

Handle multi-touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.events.touch.TouchManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.touch.TouchManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.touch.TouchManager.__init__
__init__(game: object = None) -> None

Initialize the touch event manager.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.events.window

Window.

Attributes
glitchygames.events.window.LOG module-attribute
LOG = getLogger('game.window')
Classes
glitchygames.events.window.WindowManager

Bases: ResourceManager

Window manager event handler.

Attributes
glitchygames.events.window.WindowManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.window.WindowManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.window.WindowManager.proxies instance-attribute
proxies = [WindowManagerProxy(game=game)]
Classes
glitchygames.events.window.WindowManager.WindowManagerProxy

Bases: WindowEvents, ResourceManager

Window manager event proxy.

Attributes
glitchygames.events.window.WindowManager.WindowManagerProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.events.window.WindowManager.WindowManagerProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.events.window.WindowManager.WindowManagerProxy.game instance-attribute
game = game
glitchygames.events.window.WindowManager.WindowManagerProxy.proxies instance-attribute
proxies = [game]
Functions
glitchygames.events.window.WindowManager.WindowManagerProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.window.WindowManager.WindowManagerProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.window.WindowManager.WindowManagerProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.events.window.WindowManager.WindowManagerProxy.__init__
__init__(game: object = None) -> None

Initialize the window manager proxy.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_close_event
on_window_close_event(event: Event) -> None

Handle the window close event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle the window enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle the window exposed event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle the window focus gained event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle the window focus lost event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle the window hidden event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle the window hit test event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle the window leave event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle the window maximized event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle the window minimized event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle the window moved event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle the window resized event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle the window restored event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle the window shown event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle the window size changed event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.WindowManagerProxy.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle the window take focus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.events.window.WindowManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.events.window.WindowManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.events.window.WindowManager.__init__
__init__(game: object = None) -> None

Initialize the window event manager.

Parameters:
  • game (object, default: None ) –

    The game instance.

Returns:
  • None

    None

glitchygames.events.window.WindowManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add window-specific arguments to the global parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    argparse.ArgumentParser

glitchygames.examples

Modules
glitchygames.examples.dt_demo

Delta Time Demo.

Attributes Classes
glitchygames.examples.dt_demo.Game

Bases: Scene

The main game class.

Attributes
glitchygames.examples.dt_demo.Game.log class-attribute instance-attribute
log = LOG
glitchygames.examples.dt_demo.Game.FPS class-attribute instance-attribute
FPS = 0
glitchygames.examples.dt_demo.Game.target_fps instance-attribute
target_fps = 0
glitchygames.examples.dt_demo.Game.fps instance-attribute
fps = 0
glitchygames.examples.dt_demo.Game.dt instance-attribute
dt = 0
glitchygames.examples.dt_demo.Game.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.dt_demo.Game.dirty instance-attribute
dirty = 1
glitchygames.examples.dt_demo.Game.options instance-attribute
options = options
glitchygames.examples.dt_demo.Game.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.examples.dt_demo.Game.name instance-attribute
name = type(self)
glitchygames.examples.dt_demo.Game.next_scene instance-attribute
next_scene = self
glitchygames.examples.dt_demo.Game.rects instance-attribute
rects = None
glitchygames.examples.dt_demo.Game.screen instance-attribute
screen = get_surface()
glitchygames.examples.dt_demo.Game.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.dt_demo.Game.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.dt_demo.Game.all_sprites instance-attribute
all_sprites = groups
glitchygames.examples.dt_demo.Game.background instance-attribute
background = Surface(get_size())
glitchygames.examples.dt_demo.Game.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.examples.dt_demo.Game.image instance-attribute
image = screen
glitchygames.examples.dt_demo.Game.rect instance-attribute
rect = get_rect()
glitchygames.examples.dt_demo.Game.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.examples.dt_demo.Game.NAME class-attribute instance-attribute
NAME = 'Delta Time Demo'
glitchygames.examples.dt_demo.Game.VERSION class-attribute instance-attribute
VERSION = '1.0'
glitchygames.examples.dt_demo.Game.font instance-attribute
font = SysFont('Calibri', 40)
glitchygames.examples.dt_demo.Game.rect_pos instance-attribute
rect_pos = 0
glitchygames.examples.dt_demo.Game.velocity instance-attribute
velocity = 5
glitchygames.examples.dt_demo.Game.record instance-attribute
record = 0
glitchygames.examples.dt_demo.Game.passed instance-attribute
passed = False
glitchygames.examples.dt_demo.Game.start instance-attribute
start = False
Functions
glitchygames.examples.dt_demo.Game.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.dt_demo.Game.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.examples.dt_demo.Game.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.__init__
__init__(options: dict, groups: LayeredDirty | None = None) -> None

Initialize the Game.

Parameters:
  • options (dict) –

    The options passed to the game.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.args classmethod
args(parser: ArgumentParser) -> None

Add game-specific arguments to the gloal parser.

This class method will get called automatically by the GameEngine class.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.dt_tick
dt_tick(dt: float) -> None

Update the scene.

This method will get called automatically by the GameEngine class.

Parameters:
  • dt (float) –

    The delta time (float).

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.update
update() -> None

Update the scene.

This method will get called automatically by the GameEngine class.

Returns:
  • None

    None

glitchygames.examples.dt_demo.Game.on_key_down_event
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.examples.dt_demo.main
main() -> None

The main entry point for the game.

glitchygames.examples.joystick_demo

Joystick Demo.

Attributes
glitchygames.examples.joystick_demo.LOG module-attribute
LOG = getLogger('game')
Classes
glitchygames.examples.joystick_demo.ShapesSprite

Bases: Sprite

A sprite class for drawing shapes.

Attributes
glitchygames.examples.joystick_demo.ShapesSprite.log class-attribute instance-attribute
log = LOG
glitchygames.examples.joystick_demo.ShapesSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.examples.joystick_demo.ShapesSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.examples.joystick_demo.ShapesSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.examples.joystick_demo.ShapesSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.examples.joystick_demo.ShapesSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.examples.joystick_demo.ShapesSprite.dt instance-attribute
dt = 0
glitchygames.examples.joystick_demo.ShapesSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.joystick_demo.ShapesSprite.name instance-attribute
name = name
glitchygames.examples.joystick_demo.ShapesSprite.parent instance-attribute
parent = parent
glitchygames.examples.joystick_demo.ShapesSprite.proxies instance-attribute
proxies = [self]
glitchygames.examples.joystick_demo.ShapesSprite.callbacks instance-attribute
callbacks = {}
glitchygames.examples.joystick_demo.ShapesSprite.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.examples.joystick_demo.ShapesSprite.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.examples.joystick_demo.ShapesSprite.use_gfxdraw instance-attribute
use_gfxdraw = True
glitchygames.examples.joystick_demo.ShapesSprite.screen instance-attribute
screen = get_surface()
glitchygames.examples.joystick_demo.ShapesSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.joystick_demo.ShapesSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.joystick_demo.ShapesSprite.image instance-attribute
image = screen
glitchygames.examples.joystick_demo.ShapesSprite.rect instance-attribute
rect = get_rect()
glitchygames.examples.joystick_demo.ShapesSprite.point instance-attribute
point = None
glitchygames.examples.joystick_demo.ShapesSprite.circle instance-attribute
circle = None
glitchygames.examples.joystick_demo.ShapesSprite.triangle instance-attribute
triangle = None
glitchygames.examples.joystick_demo.ShapesSprite.dirty instance-attribute
dirty = 1
glitchygames.examples.joystick_demo.ShapesSprite.rectangle property
rectangle: Rect

Get the rectangle.

Returns:
  • Rect

    pygame.rect.Rect: The rectangle.

Functions
glitchygames.examples.joystick_demo.ShapesSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.examples.joystick_demo.ShapesSprite.__init__
__init__(*args, **kwargs) -> None

Initialize a ShapesSprite.

Parameters:
  • *args

    Arguments to pass to the parent class.

  • **kwargs

    Keyword arguments to pass to the parent class.

Returns:
  • None

    Self

glitchygames.examples.joystick_demo.ShapesSprite.move
move(pos: tuple) -> None

Move the sprite to a new position.

Parameters:
  • pos (tuple) –

    The new position.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.ShapesSprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene

Bases: Scene

A scene for testing joysticks.

Attributes
glitchygames.examples.joystick_demo.JoystickScene.log class-attribute instance-attribute
log = LOG
glitchygames.examples.joystick_demo.JoystickScene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.examples.joystick_demo.JoystickScene.NAME class-attribute instance-attribute
NAME = 'Unnamed Scene'
glitchygames.examples.joystick_demo.JoystickScene.VERSION class-attribute instance-attribute
VERSION = '0.0'
glitchygames.examples.joystick_demo.JoystickScene.target_fps instance-attribute
target_fps = 0
glitchygames.examples.joystick_demo.JoystickScene.fps instance-attribute
fps = 0
glitchygames.examples.joystick_demo.JoystickScene.dt instance-attribute
dt = 0
glitchygames.examples.joystick_demo.JoystickScene.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.joystick_demo.JoystickScene.dirty instance-attribute
dirty = 1
glitchygames.examples.joystick_demo.JoystickScene.options instance-attribute
options = options
glitchygames.examples.joystick_demo.JoystickScene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.examples.joystick_demo.JoystickScene.name instance-attribute
name = type(self)
glitchygames.examples.joystick_demo.JoystickScene.next_scene instance-attribute
next_scene = self
glitchygames.examples.joystick_demo.JoystickScene.rects instance-attribute
rects = None
glitchygames.examples.joystick_demo.JoystickScene.screen instance-attribute
screen = get_surface()
glitchygames.examples.joystick_demo.JoystickScene.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.joystick_demo.JoystickScene.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.joystick_demo.JoystickScene.all_sprites instance-attribute
all_sprites = groups
glitchygames.examples.joystick_demo.JoystickScene.background instance-attribute
background = Surface(get_size())
glitchygames.examples.joystick_demo.JoystickScene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.examples.joystick_demo.JoystickScene.image instance-attribute
image = screen
glitchygames.examples.joystick_demo.JoystickScene.rect instance-attribute
rect = get_rect()
glitchygames.examples.joystick_demo.JoystickScene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.examples.joystick_demo.JoystickScene.tiles instance-attribute
tiles = []
glitchygames.examples.joystick_demo.JoystickScene.shapes_sprite instance-attribute
shapes_sprite = ShapesSprite(x=0, y=0, width=640, height=480)
Functions
glitchygames.examples.joystick_demo.JoystickScene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.joystick_demo.JoystickScene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_key_down_event cached
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.examples.joystick_demo.JoystickScene.__init__
__init__(groups: LayeredDirty | None = None) -> None

Initialize the JoystickScene.

Parameters:
  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.load_resources
load_resources() -> None

Load the resources.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.render
render(screen: Surface) -> None

Render the scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_left_mouse_button_up
on_left_mouse_button_up(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_left_mouse_button_down
on_left_mouse_button_down(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_pew_pew_event
on_pew_pew_event(event: Event) -> None

Handle pew pew events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_recharge_event
on_recharge_event(event: Event) -> None

Handle recharge events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.JoystickScene.on_controller_axis_motion_event
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game

Bases: Scene

The main game class. This is where the magic happens.

Attributes
glitchygames.examples.joystick_demo.Game.log class-attribute instance-attribute
log = LOG
glitchygames.examples.joystick_demo.Game.FPS class-attribute instance-attribute
FPS = 0
glitchygames.examples.joystick_demo.Game.target_fps instance-attribute
target_fps = 0
glitchygames.examples.joystick_demo.Game.fps instance-attribute
fps = 0
glitchygames.examples.joystick_demo.Game.dt instance-attribute
dt = 0
glitchygames.examples.joystick_demo.Game.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.joystick_demo.Game.dirty instance-attribute
dirty = 1
glitchygames.examples.joystick_demo.Game.options instance-attribute
options = options
glitchygames.examples.joystick_demo.Game.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.examples.joystick_demo.Game.name instance-attribute
name = type(self)
glitchygames.examples.joystick_demo.Game.rects instance-attribute
rects = None
glitchygames.examples.joystick_demo.Game.screen instance-attribute
screen = get_surface()
glitchygames.examples.joystick_demo.Game.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.joystick_demo.Game.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.joystick_demo.Game.all_sprites instance-attribute
all_sprites = groups
glitchygames.examples.joystick_demo.Game.background instance-attribute
background = Surface(get_size())
glitchygames.examples.joystick_demo.Game.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.examples.joystick_demo.Game.image instance-attribute
image = screen
glitchygames.examples.joystick_demo.Game.rect instance-attribute
rect = get_rect()
glitchygames.examples.joystick_demo.Game.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.examples.joystick_demo.Game.NAME class-attribute instance-attribute
NAME = 'Joystick and Font Demo'
glitchygames.examples.joystick_demo.Game.VERSION class-attribute instance-attribute
VERSION = '0.0'
glitchygames.examples.joystick_demo.Game.time instance-attribute
time = get('time')
glitchygames.examples.joystick_demo.Game.next_scene instance-attribute
next_scene = JoystickScene()
Functions
glitchygames.examples.joystick_demo.Game.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.joystick_demo.Game.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_key_down_event cached
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.examples.joystick_demo.Game.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.__init__
__init__(options: dict) -> None

Initialize the game.

Parameters:
  • options (dict) –

    The options passed to the game.

Returns:
  • None

    None

glitchygames.examples.joystick_demo.Game.args classmethod
args(parser: ArgumentParser) -> None

Add arguments to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • None

    None

Functions
glitchygames.examples.joystick_demo.main
main() -> None

The main function.

Returns:
  • None

    None

glitchygames.examples.paddleslap

Paddle Slap.

This is a simple game where you try to keep the ball from hitting your side of the screen.

Attributes
glitchygames.examples.paddleslap.log module-attribute
log = getLogger('game')
Classes
glitchygames.examples.paddleslap.TextSprite

Bases: Sprite

A sprite class for displaying text.

Attributes
glitchygames.examples.paddleslap.TextSprite.log class-attribute instance-attribute
log = LOG
glitchygames.examples.paddleslap.TextSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.examples.paddleslap.TextSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.examples.paddleslap.TextSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.examples.paddleslap.TextSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.examples.paddleslap.TextSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.examples.paddleslap.TextSprite.dt instance-attribute
dt = 0
glitchygames.examples.paddleslap.TextSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.paddleslap.TextSprite.name instance-attribute
name = name
glitchygames.examples.paddleslap.TextSprite.parent instance-attribute
parent = parent
glitchygames.examples.paddleslap.TextSprite.proxies instance-attribute
proxies = [self]
glitchygames.examples.paddleslap.TextSprite.callbacks instance-attribute
callbacks = {}
glitchygames.examples.paddleslap.TextSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.paddleslap.TextSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.paddleslap.TextSprite.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.examples.paddleslap.TextSprite.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.examples.paddleslap.TextSprite.background_color instance-attribute
background_color = background_color
glitchygames.examples.paddleslap.TextSprite.alpha instance-attribute
alpha = alpha
glitchygames.examples.paddleslap.TextSprite.x instance-attribute
x = x
glitchygames.examples.paddleslap.TextSprite.y instance-attribute
y = y
glitchygames.examples.paddleslap.TextSprite.image instance-attribute
image = Surface((400, 400))
glitchygames.examples.paddleslap.TextSprite.screen instance-attribute
screen = get_surface()
glitchygames.examples.paddleslap.TextSprite.rect instance-attribute
rect = get_rect()
glitchygames.examples.paddleslap.TextSprite.font_manager instance-attribute
font_manager = FontManager()
glitchygames.examples.paddleslap.TextSprite.joystick_manager instance-attribute
joystick_manager = JoystickManager()
glitchygames.examples.paddleslap.TextSprite.joystick_count instance-attribute
joystick_count = len(joysticks)
glitchygames.examples.paddleslap.TextSprite.text_box instance-attribute
text_box = TextBox(font_controller=font_manager, pos=center)
glitchygames.examples.paddleslap.TextSprite.dirty instance-attribute
dirty = 2
Functions
glitchygames.examples.paddleslap.TextSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.paddleslap.TextSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.examples.paddleslap.TextSprite.__init__
__init__(
    background_color: tuple = BLACKLUCENT,
    alpha: int = 0,
    x: int = 0,
    y: int = 0,
    groups: LayeredDirty | None = None,
) -> None

Initialize the text sprite.

Parameters:
  • background_color (tuple, default: BLACKLUCENT ) –

    The background color of the text.

  • alpha (int, default: 0 ) –

    The alpha value of the text.

  • x (int, default: 0 ) –

    The x position of the text.

  • y (int, default: 0 ) –

    The y position of the text.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.examples.paddleslap.TextSprite.update
update() -> None

Update the text sprite.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game

Bases: Scene

The main game class. This is where the magic happens.

Attributes
glitchygames.examples.paddleslap.Game.log class-attribute instance-attribute
log = LOG
glitchygames.examples.paddleslap.Game.FPS class-attribute instance-attribute
FPS = 0
glitchygames.examples.paddleslap.Game.target_fps instance-attribute
target_fps = 0
glitchygames.examples.paddleslap.Game.dt instance-attribute
dt = 0
glitchygames.examples.paddleslap.Game.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.paddleslap.Game.dirty instance-attribute
dirty = 1
glitchygames.examples.paddleslap.Game.options instance-attribute
options = options
glitchygames.examples.paddleslap.Game.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.examples.paddleslap.Game.name instance-attribute
name = type(self)
glitchygames.examples.paddleslap.Game.next_scene instance-attribute
next_scene = self
glitchygames.examples.paddleslap.Game.rects instance-attribute
rects = None
glitchygames.examples.paddleslap.Game.screen instance-attribute
screen = get_surface()
glitchygames.examples.paddleslap.Game.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.paddleslap.Game.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.paddleslap.Game.background instance-attribute
background = Surface(get_size())
glitchygames.examples.paddleslap.Game.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.examples.paddleslap.Game.image instance-attribute
image = screen
glitchygames.examples.paddleslap.Game.rect instance-attribute
rect = get_rect()
glitchygames.examples.paddleslap.Game.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.examples.paddleslap.Game.NAME class-attribute instance-attribute
NAME = 'Paddle Slap'
glitchygames.examples.paddleslap.Game.VERSION class-attribute instance-attribute
VERSION = '1.1'
glitchygames.examples.paddleslap.Game.fps instance-attribute
fps = 0
glitchygames.examples.paddleslap.Game.player1 instance-attribute
player1 = VerticalPaddle(
    "Player 1", (20, 80), (0, v_center - 40), WHITE, Speed(y=10, increment=1), collision_sound=SLAP
)
glitchygames.examples.paddleslap.Game.player2 instance-attribute
player2 = VerticalPaddle(
    "Player 2",
    (20, 80),
    (screen_width - 20, v_center - 40),
    WHITE,
    Speed(y=10, increment=1),
    collision_sound=SLAP,
)
glitchygames.examples.paddleslap.Game.balls instance-attribute
balls = [BallSprite(collision_sound=BOUNCE) for _ in range(get('balls', 1))]
glitchygames.examples.paddleslap.Game.all_sprites instance-attribute
all_sprites = LayeredDirty((player1, player2, *balls))
Functions
glitchygames.examples.paddleslap.Game.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.paddleslap.Game.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.examples.paddleslap.Game.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.__init__
__init__(options: dict, groups: LayeredDirty | None = None) -> None

Initialize the Game.

Parameters:
  • options (dict) –

    The options passed to the game.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.args classmethod
args(parser: ArgumentParser) -> None

Add arguments to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.setup
setup() -> None

Set up the game.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.dt_tick
dt_tick(dt: float) -> None

Update the game.

Parameters:
  • dt (float) –

    The delta time.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.update
update() -> None

Update the game.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_controller_axis_motion_event
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.paddleslap.Game.on_key_down_event
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.examples.paddleslap.main
main() -> None

The main function.

Returns:
  • None

    None

glitchygames.examples.text_input_demo

Text Input Demo.

Attributes
glitchygames.examples.text_input_demo.LOG module-attribute
LOG = getLogger('game')
Classes
glitchygames.examples.text_input_demo.Game

Bases: Scene

The main game class.

Attributes
glitchygames.examples.text_input_demo.Game.FPS class-attribute instance-attribute
FPS = 0
glitchygames.examples.text_input_demo.Game.target_fps instance-attribute
target_fps = 0
glitchygames.examples.text_input_demo.Game.fps instance-attribute
fps = 0
glitchygames.examples.text_input_demo.Game.dt instance-attribute
dt = 0
glitchygames.examples.text_input_demo.Game.dt_timer instance-attribute
dt_timer = 0
glitchygames.examples.text_input_demo.Game.dirty instance-attribute
dirty = 1
glitchygames.examples.text_input_demo.Game.options instance-attribute
options = options
glitchygames.examples.text_input_demo.Game.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.examples.text_input_demo.Game.name instance-attribute
name = type(self)
glitchygames.examples.text_input_demo.Game.next_scene instance-attribute
next_scene = self
glitchygames.examples.text_input_demo.Game.rects instance-attribute
rects = None
glitchygames.examples.text_input_demo.Game.screen instance-attribute
screen = get_surface()
glitchygames.examples.text_input_demo.Game.screen_width instance-attribute
screen_width = get_width()
glitchygames.examples.text_input_demo.Game.screen_height instance-attribute
screen_height = get_height()
glitchygames.examples.text_input_demo.Game.background instance-attribute
background = Surface(get_size())
glitchygames.examples.text_input_demo.Game.image instance-attribute
image = screen
glitchygames.examples.text_input_demo.Game.rect instance-attribute
rect = get_rect()
glitchygames.examples.text_input_demo.Game.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.examples.text_input_demo.Game.log class-attribute instance-attribute
log = LOG
glitchygames.examples.text_input_demo.Game.NAME class-attribute instance-attribute
NAME = 'Input Demo'
glitchygames.examples.text_input_demo.Game.VERSION class-attribute instance-attribute
VERSION = '1.0'
glitchygames.examples.text_input_demo.Game.input_box instance-attribute
input_box = InputBox(x=320, y=240, width=200, height=20, text='Test', parent=self, groups=groups)
glitchygames.examples.text_input_demo.Game.background_color instance-attribute
background_color = (255, 255, 0)
glitchygames.examples.text_input_demo.Game.all_sprites instance-attribute
all_sprites = LayeredDirty(input_box)
Functions
glitchygames.examples.text_input_demo.Game.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.examples.text_input_demo.Game.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.examples.text_input_demo.Game.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.__init__
__init__(options: dict, groups: LayeredDirty | None = None) -> None

Initialize the Game.

Parameters:
  • options (dict) –

    The options passed to the game.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.setup classmethod
setup() -> None

Set up the game.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.update
update() -> None

Update the game.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_input_box_submit_event
on_input_box_submit_event(control: object) -> None

Handle input box submit events.

Parameters:
  • control (object) –

    The control that submitted the event.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.examples.text_input_demo.Game.on_key_down_event
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Functions
glitchygames.examples.text_input_demo.main
main() -> None

The main entry point for the game.

glitchygames.fonts

Fonts.

This is a simple font manager that can be used to load fonts.

Attributes
glitchygames.fonts.log module-attribute
log = getLogger('game.fonts')
Classes
glitchygames.fonts.FontManager

Bases: ResourceManager

A font manager.

Attributes
glitchygames.fonts.FontManager.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.fonts.FontManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.fonts.FontManager.proxies instance-attribute
proxies = []
glitchygames.fonts.FontManager.OPTIONS class-attribute instance-attribute
OPTIONS: ClassVar = {}
glitchygames.fonts.FontManager.RENDER_CACHE class-attribute instance-attribute
RENDER_CACHE: ClassVar = {}
Classes
glitchygames.fonts.FontManager.FontProxy

Bases: FontEvents, ResourceManager

A font proxy.

Attributes
glitchygames.fonts.FontManager.FontProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.fonts.FontManager.FontProxy.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.fonts.FontManager.FontProxy.game instance-attribute
game = game
glitchygames.fonts.FontManager.FontProxy.proxies instance-attribute
proxies = [game, freetype]
Functions
glitchygames.fonts.FontManager.FontProxy.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.fonts.FontManager.FontProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.fonts.FontManager.FontProxy.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.fonts.FontManager.FontProxy.on_font_changed_event abstractmethod
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.fonts.FontManager.FontProxy.__init__
__init__(game: object = None) -> None

Initialize the font proxy.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

Functions
glitchygames.fonts.FontManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.fonts.FontManager.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Raises:
  • AttributeError

    If the attribute is not found.

glitchygames.fonts.FontManager.__init__
__init__(game: object = None) -> None

Initialize the font manager.

Parameters:
  • game (object, default: None ) –

    The game object.

Returns:
  • None

    None

glitchygames.fonts.FontManager.args classmethod
args(parser: ArgumentParser) -> ArgumentParser

Add font options to the argument parser.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • ArgumentParser

    argparse.ArgumentParser

glitchygames.fonts.FontManager.font classmethod
font(font_config: dict | None = None) -> Font | SysFont

Return a font object.

If the font requested can't be found then bitstream_vera will be loaded instead.

Note that if you are trying to package your game with pyinstaller, you'll need to bundle your game's fonts with the pyinstaller invocation. Make sure you have distribution rights to the fonts you're including with your game.

bitstream_vera is a permissively licensed font that can be used with your game.

Parameters:
  • font_config (dict | None, default: None ) –

    The font configuration.

Returns:
  • Font | SysFont

    pygame.freetype.Font | pygame.freetype.SysFont

glitchygames.game_objects

Functions
glitchygames.game_objects.load_sound
load_sound(snd_file: str, volume: float = 0.25) -> Sound

Load a sound file.

Parameters:
  • snd_file (str) –

    The sound file to load.

  • volume (float, default: 0.25 ) –

    The volume to set the sound to.

Returns:
  • Sound

    pygame.mixer.Sound: The sound object.

Modules
glitchygames.game_objects.ball

Ball.

Attributes Classes
glitchygames.game_objects.ball.BallSprite

Bases: Sprite

Ball Sprite.

Attributes
glitchygames.game_objects.ball.BallSprite.rect instance-attribute
rect = get_rect()
glitchygames.game_objects.ball.BallSprite.image instance-attribute
image = Surface((width, height))
glitchygames.game_objects.ball.BallSprite.log class-attribute instance-attribute
log = LOG
glitchygames.game_objects.ball.BallSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.game_objects.ball.BallSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.game_objects.ball.BallSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.game_objects.ball.BallSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.game_objects.ball.BallSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.game_objects.ball.BallSprite.dt instance-attribute
dt = 0
glitchygames.game_objects.ball.BallSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.game_objects.ball.BallSprite.name instance-attribute
name = name
glitchygames.game_objects.ball.BallSprite.parent instance-attribute
parent = parent
glitchygames.game_objects.ball.BallSprite.proxies instance-attribute
proxies = [self]
glitchygames.game_objects.ball.BallSprite.callbacks instance-attribute
callbacks = {}
glitchygames.game_objects.ball.BallSprite.screen instance-attribute
screen = get_surface()
glitchygames.game_objects.ball.BallSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.game_objects.ball.BallSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.game_objects.ball.BallSprite.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.game_objects.ball.BallSprite.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.game_objects.ball.BallSprite.use_gfxdraw instance-attribute
use_gfxdraw = True
glitchygames.game_objects.ball.BallSprite.direction instance-attribute
direction = 0
glitchygames.game_objects.ball.BallSprite.speed instance-attribute
speed = Speed(4, 2)
glitchygames.game_objects.ball.BallSprite.snd instance-attribute
snd = load_sound(collision_sound)
glitchygames.game_objects.ball.BallSprite.dirty instance-attribute
dirty = 2
glitchygames.game_objects.ball.BallSprite.color property writable
color: tuple[int, int, int]

Get the color of the ball.

Returns:
  • tuple[int, int, int]

    tuple[int, int, int]: The color of the ball.

Functions
glitchygames.game_objects.ball.BallSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.game_objects.ball.BallSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.game_objects.ball.BallSprite.__init__
__init__(
    x: int = 0,
    y: int = 0,
    width: int = 20,
    height: int = 20,
    groups: LayeredDirty | None = None,
    collision_sound: str | None = None,
) -> None

Initialize the ball sprite.

Parameters:
  • x (int, default: 0 ) –

    The x position of the ball.

  • y (int, default: 0 ) –

    The y position of the ball.

  • width (int, default: 20 ) –

    The width of the ball.

  • height (int, default: 20 ) –

    The height of the ball.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

  • collision_sound (str | None, default: None ) –

    The sound to play on collision.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.reset
reset() -> None

Reset the ball.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.bounce
bounce(diff: int) -> None

Bounce the ball.

Parameters:
  • diff (int) –

    The difference.

Returns:
  • None

    None

glitchygames.game_objects.ball.BallSprite.update
update() -> None

Update the ball.

Returns:
  • None

    None

Modules
glitchygames.game_objects.paddle

Paddle.

Attributes
glitchygames.game_objects.paddle.log module-attribute
log = getLogger('game.paddle')
Classes
glitchygames.game_objects.paddle.BasePaddle

Bases: Sprite

Base Paddle class.

Attributes
glitchygames.game_objects.paddle.BasePaddle.rect instance-attribute
rect = get_rect()
glitchygames.game_objects.paddle.BasePaddle.image instance-attribute
image = Surface((width, height))
glitchygames.game_objects.paddle.BasePaddle.log class-attribute instance-attribute
log = LOG
glitchygames.game_objects.paddle.BasePaddle.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.game_objects.paddle.BasePaddle.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.game_objects.paddle.BasePaddle.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.game_objects.paddle.BasePaddle.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.game_objects.paddle.BasePaddle.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.game_objects.paddle.BasePaddle.dt instance-attribute
dt = 0
glitchygames.game_objects.paddle.BasePaddle.dt_timer instance-attribute
dt_timer = 0
glitchygames.game_objects.paddle.BasePaddle.name instance-attribute
name = name
glitchygames.game_objects.paddle.BasePaddle.parent instance-attribute
parent = parent
glitchygames.game_objects.paddle.BasePaddle.proxies instance-attribute
proxies = [self]
glitchygames.game_objects.paddle.BasePaddle.callbacks instance-attribute
callbacks = {}
glitchygames.game_objects.paddle.BasePaddle.screen instance-attribute
screen = get_surface()
glitchygames.game_objects.paddle.BasePaddle.screen_width instance-attribute
screen_width = get_width()
glitchygames.game_objects.paddle.BasePaddle.screen_height instance-attribute
screen_height = get_height()
glitchygames.game_objects.paddle.BasePaddle.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.game_objects.paddle.BasePaddle.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.game_objects.paddle.BasePaddle.use_gfxdraw instance-attribute
use_gfxdraw = True
glitchygames.game_objects.paddle.BasePaddle.moving instance-attribute
moving = False
glitchygames.game_objects.paddle.BasePaddle.snd instance-attribute
snd = load_sound(collision_sound)
glitchygames.game_objects.paddle.BasePaddle.dirty instance-attribute
dirty = 1
Functions
glitchygames.game_objects.paddle.BasePaddle.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.game_objects.paddle.BasePaddle.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.game_objects.paddle.BasePaddle.__init__
__init__(
    axis: Horizontal | Vertical,
    speed: int,
    name: str,
    color: tuple,
    x: int,
    y: int,
    width: int,
    height: int,
    groups: LayeredDirty | None = None,
    collision_sound: str | None = None,
) -> None

Initialize the paddle.

Parameters:
  • axis (Horizontal | Vertical) –

    The axis to move on.

  • speed (int) –

    The speed to move at.

  • name (str) –

    The name of the paddle.

  • color (tuple) –

    The color of the paddle.

  • x (int) –

    The x position of the paddle.

  • y (int) –

    The y position of the paddle.

  • width (int) –

    The width of the paddle.

  • height (int) –

    The height of the paddle.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

  • collision_sound (str | None, default: None ) –

    The sound to play on collision.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.move_horizontal
move_horizontal() -> None

Move the paddle horizontally.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.move_vertical
move_vertical() -> None

Move the paddle vertically.

Returns:
  • None

    None

glitchygames.game_objects.paddle.BasePaddle.is_at_bottom_of_screen
is_at_bottom_of_screen() -> bool

Check if the paddle is at the bottom of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the bottom of the screen, False otherwise.

glitchygames.game_objects.paddle.BasePaddle.is_at_top_of_screen
is_at_top_of_screen() -> bool

Check if the paddle is at the top of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the top of the screen, False otherwise.

glitchygames.game_objects.paddle.BasePaddle.is_at_left_of_screen
is_at_left_of_screen() -> bool

Check if the paddle is at the left of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the left of the screen, False otherwise.

glitchygames.game_objects.paddle.BasePaddle.is_at_right_of_screen
is_at_right_of_screen() -> bool

Check if the paddle is at the right of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the right of the screen, False otherwise.

glitchygames.game_objects.paddle.HorizontalPaddle

Bases: BasePaddle

Horizontal Paddle.

Attributes
glitchygames.game_objects.paddle.HorizontalPaddle.rect instance-attribute
rect = get_rect()
glitchygames.game_objects.paddle.HorizontalPaddle.image instance-attribute
image = Surface((width, height))
glitchygames.game_objects.paddle.HorizontalPaddle.log class-attribute instance-attribute
log = LOG
glitchygames.game_objects.paddle.HorizontalPaddle.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.game_objects.paddle.HorizontalPaddle.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.game_objects.paddle.HorizontalPaddle.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.game_objects.paddle.HorizontalPaddle.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.game_objects.paddle.HorizontalPaddle.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.game_objects.paddle.HorizontalPaddle.dt instance-attribute
dt = 0
glitchygames.game_objects.paddle.HorizontalPaddle.dt_timer instance-attribute
dt_timer = 0
glitchygames.game_objects.paddle.HorizontalPaddle.name instance-attribute
name = name
glitchygames.game_objects.paddle.HorizontalPaddle.parent instance-attribute
parent = parent
glitchygames.game_objects.paddle.HorizontalPaddle.proxies instance-attribute
proxies = [self]
glitchygames.game_objects.paddle.HorizontalPaddle.callbacks instance-attribute
callbacks = {}
glitchygames.game_objects.paddle.HorizontalPaddle.screen instance-attribute
screen = get_surface()
glitchygames.game_objects.paddle.HorizontalPaddle.screen_width instance-attribute
screen_width = get_width()
glitchygames.game_objects.paddle.HorizontalPaddle.screen_height instance-attribute
screen_height = get_height()
glitchygames.game_objects.paddle.HorizontalPaddle.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.game_objects.paddle.HorizontalPaddle.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.game_objects.paddle.HorizontalPaddle.use_gfxdraw instance-attribute
use_gfxdraw = True
glitchygames.game_objects.paddle.HorizontalPaddle.moving instance-attribute
moving = False
glitchygames.game_objects.paddle.HorizontalPaddle.snd instance-attribute
snd = load_sound(collision_sound)
glitchygames.game_objects.paddle.HorizontalPaddle.dirty instance-attribute
dirty = 1
Functions
glitchygames.game_objects.paddle.HorizontalPaddle.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.game_objects.paddle.HorizontalPaddle.move_horizontal
move_horizontal() -> None

Move the paddle horizontally.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.move_vertical
move_vertical() -> None

Move the paddle vertically.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.is_at_bottom_of_screen
is_at_bottom_of_screen() -> bool

Check if the paddle is at the bottom of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the bottom of the screen, False otherwise.

glitchygames.game_objects.paddle.HorizontalPaddle.is_at_top_of_screen
is_at_top_of_screen() -> bool

Check if the paddle is at the top of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the top of the screen, False otherwise.

glitchygames.game_objects.paddle.HorizontalPaddle.is_at_left_of_screen
is_at_left_of_screen() -> bool

Check if the paddle is at the left of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the left of the screen, False otherwise.

glitchygames.game_objects.paddle.HorizontalPaddle.is_at_right_of_screen
is_at_right_of_screen() -> bool

Check if the paddle is at the right of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the right of the screen, False otherwise.

glitchygames.game_objects.paddle.HorizontalPaddle.__init__
__init__(
    name: str,
    size: tuple,
    position: tuple,
    color: tuple,
    speed: int,
    groups: LayeredDirty | None = None,
    collision_sound: str | None = None,
) -> None

Initialize the horizontal paddle.

Parameters:
  • name (str) –

    The name of the paddle.

  • size (tuple) –

    The size of the paddle.

  • position (tuple) –

    The position of the paddle.

  • color (tuple) –

    The color of the paddle.

  • speed (int) –

    The speed to move at.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

  • collision_sound (str | None, default: None ) –

    The sound to play on collision.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.update
update() -> None

Update the paddle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.left
left() -> None

Move left.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.right
right() -> None

Move right.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.stop
stop() -> None

Stop moving.

Returns:
  • None

    None

glitchygames.game_objects.paddle.HorizontalPaddle.speed_up
speed_up() -> None

Speed up.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle

Bases: BasePaddle

Vertical Paddle.

Attributes
glitchygames.game_objects.paddle.VerticalPaddle.rect instance-attribute
rect = get_rect()
glitchygames.game_objects.paddle.VerticalPaddle.image instance-attribute
image = Surface((width, height))
glitchygames.game_objects.paddle.VerticalPaddle.log class-attribute instance-attribute
log = LOG
glitchygames.game_objects.paddle.VerticalPaddle.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.game_objects.paddle.VerticalPaddle.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.game_objects.paddle.VerticalPaddle.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.game_objects.paddle.VerticalPaddle.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.game_objects.paddle.VerticalPaddle.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.game_objects.paddle.VerticalPaddle.dt instance-attribute
dt = 0
glitchygames.game_objects.paddle.VerticalPaddle.dt_timer instance-attribute
dt_timer = 0
glitchygames.game_objects.paddle.VerticalPaddle.name instance-attribute
name = name
glitchygames.game_objects.paddle.VerticalPaddle.parent instance-attribute
parent = parent
glitchygames.game_objects.paddle.VerticalPaddle.proxies instance-attribute
proxies = [self]
glitchygames.game_objects.paddle.VerticalPaddle.callbacks instance-attribute
callbacks = {}
glitchygames.game_objects.paddle.VerticalPaddle.screen instance-attribute
screen = get_surface()
glitchygames.game_objects.paddle.VerticalPaddle.screen_width instance-attribute
screen_width = get_width()
glitchygames.game_objects.paddle.VerticalPaddle.screen_height instance-attribute
screen_height = get_height()
glitchygames.game_objects.paddle.VerticalPaddle.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.game_objects.paddle.VerticalPaddle.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.game_objects.paddle.VerticalPaddle.use_gfxdraw instance-attribute
use_gfxdraw = True
glitchygames.game_objects.paddle.VerticalPaddle.moving instance-attribute
moving = False
glitchygames.game_objects.paddle.VerticalPaddle.snd instance-attribute
snd = load_sound(collision_sound)
glitchygames.game_objects.paddle.VerticalPaddle.dirty instance-attribute
dirty = 1
Functions
glitchygames.game_objects.paddle.VerticalPaddle.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.game_objects.paddle.VerticalPaddle.move_horizontal
move_horizontal() -> None

Move the paddle horizontally.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.move_vertical
move_vertical() -> None

Move the paddle vertically.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.is_at_bottom_of_screen
is_at_bottom_of_screen() -> bool

Check if the paddle is at the bottom of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the bottom of the screen, False otherwise.

glitchygames.game_objects.paddle.VerticalPaddle.is_at_top_of_screen
is_at_top_of_screen() -> bool

Check if the paddle is at the top of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the top of the screen, False otherwise.

glitchygames.game_objects.paddle.VerticalPaddle.is_at_left_of_screen
is_at_left_of_screen() -> bool

Check if the paddle is at the left of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the left of the screen, False otherwise.

glitchygames.game_objects.paddle.VerticalPaddle.is_at_right_of_screen
is_at_right_of_screen() -> bool

Check if the paddle is at the right of the screen.

Returns:
  • bool( bool ) –

    True if the paddle is at the right of the screen, False otherwise.

glitchygames.game_objects.paddle.VerticalPaddle.__init__
__init__(
    name: str,
    size: tuple,
    position: tuple,
    color: tuple,
    speed: int,
    groups: LayeredDirty | None = None,
    collision_sound: str | None = None,
) -> None

Initialize the vertical paddle.

Parameters:
  • name (str) –

    The name of the paddle.

  • size (tuple) –

    The size of the paddle.

  • position (tuple) –

    The position of the paddle.

  • color (tuple) –

    The color of the paddle.

  • speed (int) –

    The speed to move at.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

  • collision_sound (str | None, default: None ) –

    The sound to play on collision.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.update
update() -> None

Update the paddle.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.up
up() -> None

Move up.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.down
down() -> None

Move down.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.stop
stop() -> None

Stop moving.

Returns:
  • None

    None

glitchygames.game_objects.paddle.VerticalPaddle.speed_up
speed_up() -> None

Speed up.

Returns:
  • None

    None

Functions
glitchygames.game_objects.sounds

Sounds.

Classes
glitchygames.game_objects.sounds.SFX

Sound effects.

Attributes
glitchygames.game_objects.sounds.SFX.BOUNCE class-attribute instance-attribute
BOUNCE = 'sfx_bounce.wav'
glitchygames.game_objects.sounds.SFX.SLAP class-attribute instance-attribute
SLAP = 'sfx_slap.wav'

glitchygames.interfaces

Modules
glitchygames.interfaces.interfaces

Interfaces for the game.

Classes
glitchygames.interfaces.interfaces.SpriteInterface

Sprite interface.

Functions
glitchygames.interfaces.interfaces.SpriteInterface.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.interfaces.interfaces.SpriteInterface.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.interfaces.interfaces.SpriteInterface.render
render(screen: Surface) -> None

Render the sprite.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.interfaces.interfaces.SceneInterface

Scene interface.

Functions
glitchygames.interfaces.interfaces.SceneInterface.switch_to_scene
switch_to_scene(next_scene: SceneInterface) -> None

Switch to the next scene.

Parameters:
Returns:
  • None

    None

glitchygames.interfaces.interfaces.SceneInterface.terminate
terminate() -> None

Terminate the scene.

Returns:
  • None

    None

glitchygames.interfaces.interfaces.SceneInterface.play
play() -> None

Play the scene.

Returns:
  • None

    None

glitchygames.interfaces.interfaces.SceneInterface.pause
pause() -> None

Pause the scene.

Returns:
  • None

    None

glitchygames.movement

Modules
glitchygames.movement.horizontal

Horizontal Movement.

This is a simple horizontal movement class that can be used to move sprites left and right.

Classes
glitchygames.movement.horizontal.Horizontal

Horizontal movement.

Attributes
glitchygames.movement.horizontal.Horizontal.speed instance-attribute
speed = speed
glitchygames.movement.horizontal.Horizontal.current_speed instance-attribute
current_speed = x
Functions
glitchygames.movement.horizontal.Horizontal.__init__
__init__(speed: int) -> None

Initialize the horizontal movement.

Parameters:
  • speed (int) –

    The speed to move at.

Returns:
  • None

    None

glitchygames.movement.horizontal.Horizontal.left
left() -> None

Move left.

Returns:
  • None

    None

glitchygames.movement.horizontal.Horizontal.right
right() -> None

Move right.

Returns:
  • None

    None

glitchygames.movement.horizontal.Horizontal.stop
stop() -> None

Stop moving.

Returns:
  • None

    None

glitchygames.movement.speed

Speed.

This is a simple speed class that can be used to speed up sprites.

Classes
glitchygames.movement.speed.Speed

Speed.

Attributes
glitchygames.movement.speed.Speed.x instance-attribute
x = x
glitchygames.movement.speed.Speed.y instance-attribute
y = y
glitchygames.movement.speed.Speed.increment instance-attribute
increment = increment
Functions
glitchygames.movement.speed.Speed.__init__
__init__(x: int = 0, y: int = 0, increment: float = 0.2) -> None

Initialize the speed.

Parameters:
  • x (int, default: 0 ) –

    The x speed.

  • y (int, default: 0 ) –

    The y speed.

  • increment (float, default: 0.2 ) –

    The amount to increment the speed by.

Returns:
  • None

    None

glitchygames.movement.speed.Speed.speed_up
speed_up() -> None

Speed up.

Returns:
  • None

    None

glitchygames.movement.speed.Speed.speed_up_horizontal
speed_up_horizontal() -> None

Speed up horizontally.

Returns:
  • None

    None

glitchygames.movement.speed.Speed.speed_up_vertical
speed_up_vertical() -> None

Speed up vertically.

Returns:
  • None

    None

glitchygames.movement.vertical

Vertical Movement.

This is a simple vertical movement class that can be used to move sprites up and down.

Classes
glitchygames.movement.vertical.Vertical

Vertical movement.

Attributes
glitchygames.movement.vertical.Vertical.speed instance-attribute
speed = speed
glitchygames.movement.vertical.Vertical.current_speed instance-attribute
current_speed = y
Functions
glitchygames.movement.vertical.Vertical.__init__
__init__(speed: int) -> None

Initialize the vertical movement.

Parameters:
  • speed (int) –

    The speed to move at.

Returns:
  • None

    None

glitchygames.movement.vertical.Vertical.up
up() -> None

Move up.

Returns:
  • None

    None

glitchygames.movement.vertical.Vertical.down
down() -> None

Move down.

Returns:
  • None

    None

glitchygames.movement.vertical.Vertical.stop
stop() -> None

Stop moving.

Returns:
  • None

    None

glitchygames.pixels

Pixel data handling.

Attributes
glitchygames.pixels.LOG module-attribute
LOG = getLogger('game.pixels')
Functions
glitchygames.pixels.indexed_rgb_triplet_generator
indexed_rgb_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]

Yield (R, G, B) pixel tuples from a buffer of pixel tuples.

glitchygames.pixels.rgb_555_triplet_generator
rgb_555_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]

Yield (R, G, B) pixel tuples for 555 formated color data.

glitchygames.pixels.rgb_565_triplet_generator
rgb_565_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]

Yield (R, G, B) tuples for 565 formatted color data.

glitchygames.pixels.rgb_triplet_generator
rgb_triplet_generator(pixel_data: iter) -> iter[tuple[int, int, int]]

Yield (R, G, B) tuples for the provided pixel data.

glitchygames.pixels.image_from_pixels
image_from_pixels(pixels: list, width: int, height: int) -> Surface

Produce a pygame.image object for the specified [(R, G, B), ...] pixel data.

glitchygames.pixels.pixels_from_data
pixels_from_data(pixel_data: list) -> list

Expand raw pixel data into [(R, G, B), ...] triplets.

glitchygames.pixels.pixels_from_path
pixels_from_path(path: str) -> list

Expand raw pixel data from file into [(R, G, B), ...] triplets.

glitchygames.scenes

Glitchy Games Engine scenes module.

Attributes
glitchygames.scenes.LOG module-attribute
LOG = getLogger('game.scenes')
Classes
glitchygames.scenes.SceneManager

Bases: SceneInterface, EventManager

Glitchy Games Scene Manager.

The scene manager is responsible for managing the active scene, and for processing events.

Attributes
glitchygames.scenes.SceneManager.__instances__ class-attribute instance-attribute
__instances__: ClassVar = {}
glitchygames.scenes.SceneManager.proxies instance-attribute
proxies = [EventProxy(event_source=self)]
glitchygames.scenes.SceneManager.log class-attribute instance-attribute
log: ClassVar = LOG
glitchygames.scenes.SceneManager.OPTIONS class-attribute instance-attribute
OPTIONS: ClassVar = {}
glitchygames.scenes.SceneManager.screen instance-attribute
screen = get_surface()
glitchygames.scenes.SceneManager.update_type instance-attribute
update_type = 'update'
glitchygames.scenes.SceneManager.fps_refresh_rate instance-attribute
fps_refresh_rate = 1000
glitchygames.scenes.SceneManager.target_fps instance-attribute
target_fps = 0
glitchygames.scenes.SceneManager.dt instance-attribute
dt = 0
glitchygames.scenes.SceneManager.timer instance-attribute
timer = 0
glitchygames.scenes.SceneManager.active_scene instance-attribute
active_scene = None
glitchygames.scenes.SceneManager.next_scene instance-attribute
next_scene = active_scene
glitchygames.scenes.SceneManager.previous_scene instance-attribute
previous_scene = active_scene
glitchygames.scenes.SceneManager.quit_requested instance-attribute
quit_requested = False
glitchygames.scenes.SceneManager.clock instance-attribute
clock = Clock()
glitchygames.scenes.SceneManager.game_engine property writable
game_engine: object

Return the game engine.

Returns:
  • object( object ) –

    The game engine.

glitchygames.scenes.SceneManager.all_sprites property
all_sprites: LayeredDirty | None

Return the active scene's sprite group.

Returns:
  • LayeredDirty | None

    pygame.sprite.LayeredDirty | None: The active scene's sprite group.

Classes
glitchygames.scenes.SceneManager.EventProxy

Proxy for events.

Attributes
glitchygames.scenes.SceneManager.EventProxy.log class-attribute instance-attribute
log: Logger = LOG
glitchygames.scenes.SceneManager.EventProxy.proxies instance-attribute
proxies = []
glitchygames.scenes.SceneManager.EventProxy.event_source instance-attribute
event_source = event_source
Functions
glitchygames.scenes.SceneManager.EventProxy.__init__
__init__(event_source: object) -> None

Initialize the event proxy.

Parameters:
  • event_source (object) –

    The event source.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.EventProxy.unhandled_event
unhandled_event(*args, **kwargs) -> None

Handle unhandled events.

Parameters:
  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.EventProxy.__getattr__
__getattr__(attr: str) -> Callable

Get an attribute.

This method is called when an attribute is not found.

Parameters:
  • attr (str) –

    The attribute to get.

Returns:
  • Callable

    The attribute.

Functions
glitchygames.scenes.SceneManager.__new__
__new__(*args, **kwargs) -> object

Create a new instance of the class.

This method is called when a new instance of the class

Parameters:
  • cls (Self) –

    The class.

  • *args

    The positional arguments.

  • **kwargs

    The keyword arguments.

Returns:
  • object

    The new instance of the class.

Raises:
  • AttributeError

    If the event is not handled by any proxy.

glitchygames.scenes.SceneManager.__init__
__init__() -> None

Initialize the scene manager.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.switch_to_scene
switch_to_scene(next_scene: Scene) -> None

Switch to the next scene.

Parameters:
  • next_scene (Scene) –

    The next scene to switch to.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.play
play() -> None
glitchygames.scenes.SceneManager.start
start() -> None

Start the scene manager.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.stop
stop() -> None
glitchygames.scenes.SceneManager.terminate
terminate() -> None

Terminate the scene manager.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.quit
quit() -> None

Quit the game.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.quit_game
quit_game() -> None

Quit the game.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.on_game_event
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.register_game_event
register_game_event(event_type: EventType, callback: Callable) -> None

Register a game event.

Parameters:
  • event_type (EventType) –

    The event type to register.

  • callback (Callable) –

    The callback to call when the event is triggered.

Returns:
  • None

    None

glitchygames.scenes.SceneManager.__getattr__
__getattr__(attr: str) -> Callable

Proxy calls to the active scene.

Parameters:
  • attr (str) –

    The attribute to proxy.

Returns:
  • Callable( Callable ) –

    The callable object.

glitchygames.scenes.Scene

Bases: SceneInterface, SpriteInterface, AllEventStubs

Scene object base class.

Subclass this to properly receive on_*_event() messages automatically.

Attributes
glitchygames.scenes.Scene.log class-attribute instance-attribute
log = LOG
glitchygames.scenes.Scene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.scenes.Scene.NAME class-attribute instance-attribute
NAME = 'Unnamed Scene'
glitchygames.scenes.Scene.VERSION class-attribute instance-attribute
VERSION = '0.0'
glitchygames.scenes.Scene.target_fps instance-attribute
target_fps = 0
glitchygames.scenes.Scene.fps instance-attribute
fps = 0
glitchygames.scenes.Scene.dt instance-attribute
dt = 0
glitchygames.scenes.Scene.dt_timer instance-attribute
dt_timer = 0
glitchygames.scenes.Scene.options instance-attribute
options = options
glitchygames.scenes.Scene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.scenes.Scene.name instance-attribute
name = type(self)
glitchygames.scenes.Scene.next_scene instance-attribute
next_scene = self
glitchygames.scenes.Scene.rects instance-attribute
rects = None
glitchygames.scenes.Scene.screen_width instance-attribute
screen_width = get_width()
glitchygames.scenes.Scene.screen_height instance-attribute
screen_height = get_height()
glitchygames.scenes.Scene.all_sprites instance-attribute
all_sprites = groups
glitchygames.scenes.Scene.screen instance-attribute
screen = get_surface()
glitchygames.scenes.Scene.background instance-attribute
background = Surface(get_size())
glitchygames.scenes.Scene.image instance-attribute
image = screen
glitchygames.scenes.Scene.rect instance-attribute
rect = get_rect()
glitchygames.scenes.Scene.dirty instance-attribute
dirty = 1
glitchygames.scenes.Scene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.scenes.Scene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

Functions
glitchygames.scenes.Scene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.scenes.Scene.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_key_down_event cached
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.__init__
__init__(options: dict | None = None, groups: LayeredDirty | None = None) -> None

Initialize the scene.

Parameters:
  • options (dict | None, default: None ) –

    The options passed to the game.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.scenes.Scene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.scenes.Scene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.scenes.Scene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.scenes.Scene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.scenes.Scene.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.scenes.Scene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.scenes.Scene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.scenes.Scene.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

Modules

glitchygames.sprites

Glitchy Games Engine sprite module.

Attributes
glitchygames.sprites.LOG module-attribute
LOG = getLogger('game.sprites')
Classes
glitchygames.sprites.RootSprite

Bases: MouseEvents, SpriteInterface, DirtySprite

A root sprite class. All Glitchy Games sprites inherit from this class.

Attributes
glitchygames.sprites.RootSprite.rect instance-attribute
rect = Rect(0, 0, 0, 0)
glitchygames.sprites.RootSprite.image instance-attribute
image = None
Functions
glitchygames.sprites.RootSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.sprites.RootSprite.on_mouse_motion_event abstractmethod
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_drag_event abstractmethod
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_drop_event abstractmethod
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_left_mouse_drag_event abstractmethod
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_left_mouse_drop_event abstractmethod
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_middle_mouse_drag_event abstractmethod
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_middle_mouse_drop_event abstractmethod
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_right_mouse_drag_event abstractmethod
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_right_mouse_drop_event abstractmethod
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_focus_event abstractmethod
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_unfocus_event abstractmethod
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_button_up_event abstractmethod
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_left_mouse_button_up_event abstractmethod
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_middle_mouse_button_up_event abstractmethod
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_right_mouse_button_up_event abstractmethod
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_button_down_event abstractmethod
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_left_mouse_button_down_event abstractmethod
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_middle_mouse_button_down_event abstractmethod
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_right_mouse_button_down_event abstractmethod
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_scroll_down_event abstractmethod
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_scroll_up_event abstractmethod
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.on_mouse_wheel_event abstractmethod
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.RootSprite.__init__
__init__(groups: LayeredDirty | None = None) -> None

Initialize a RootSprite.

Parameters:
  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.sprites.Sprite

Bases: RootSprite

A convenience class for handling all of the common sprite behaviors.

Attributes
glitchygames.sprites.Sprite.log class-attribute instance-attribute
log = LOG
glitchygames.sprites.Sprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.sprites.Sprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.sprites.Sprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.sprites.Sprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.sprites.Sprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.sprites.Sprite.image instance-attribute
image = Surface((width, height))
glitchygames.sprites.Sprite.rect instance-attribute
rect = get_rect()
glitchygames.sprites.Sprite.dt instance-attribute
dt = 0
glitchygames.sprites.Sprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.sprites.Sprite.name instance-attribute
name = name
glitchygames.sprites.Sprite.parent instance-attribute
parent = parent
glitchygames.sprites.Sprite.proxies instance-attribute
proxies = [self]
glitchygames.sprites.Sprite.callbacks instance-attribute
callbacks = {}
glitchygames.sprites.Sprite.screen instance-attribute
screen = get_surface()
glitchygames.sprites.Sprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.sprites.Sprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.sprites.Sprite.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.sprites.Sprite.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

Functions
glitchygames.sprites.Sprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.sprites.Sprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.sprites.Sprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a Sprite.

Parameters:
  • x (int) –

    The x coordinate of the sprite.

  • y (int) –

    The y coordinate of the sprite.

  • width (int) –

    The width of the sprite.

  • height (int) –

    The height of the sprite.

  • name (str | None, default: None ) –

    The name of the sprite.

  • parent (object | None, default: None ) –

    The parent of the sprite.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.sprites.Sprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.sprites.Sprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.Sprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.sprites.BitmappySprite

Bases: Sprite

A sprite that loads from a Bitmappy config file.

Attributes
glitchygames.sprites.BitmappySprite.log class-attribute instance-attribute
log = LOG
glitchygames.sprites.BitmappySprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.sprites.BitmappySprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.sprites.BitmappySprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.sprites.BitmappySprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.sprites.BitmappySprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.sprites.BitmappySprite.dt instance-attribute
dt = 0
glitchygames.sprites.BitmappySprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.sprites.BitmappySprite.name instance-attribute
name = name
glitchygames.sprites.BitmappySprite.callbacks instance-attribute
callbacks = {}
glitchygames.sprites.BitmappySprite.screen instance-attribute
screen = get_surface()
glitchygames.sprites.BitmappySprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.sprites.BitmappySprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.sprites.BitmappySprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.sprites.BitmappySprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.sprites.BitmappySprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.sprites.BitmappySprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.sprites.BitmappySprite.filename instance-attribute
filename = filename
glitchygames.sprites.BitmappySprite.focusable instance-attribute
focusable = focusable
glitchygames.sprites.BitmappySprite.width instance-attribute
width = width
glitchygames.sprites.BitmappySprite.height instance-attribute
height = height
glitchygames.sprites.BitmappySprite.image instance-attribute
image = Surface((width, height))
glitchygames.sprites.BitmappySprite.rect instance-attribute
rect = get_rect()
glitchygames.sprites.BitmappySprite.parent instance-attribute
parent = parent
glitchygames.sprites.BitmappySprite.proxies instance-attribute
proxies = [parent]
Functions
glitchygames.sprites.BitmappySprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.sprites.BitmappySprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.sprites.BitmappySprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    filename: str | None = None,
    focusable: bool = False,
    parent: object = None,
    groups: LayeredDirty | None = None,
) -> None

Subclass to load sprite files.

Parameters:
  • x (int) –

    the x coordinate of the sprite.

  • y (int) –

    the y coordinate of the sprite.

  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • name (str | None, default: None ) –

    optional, the name of the sprite.

  • filename (str | None, default: None ) –

    optional, the BitmappySprite config to load.

  • focusable (bool, default: False ) –

    optional, whether or not the sprite can receive focus.

  • parent (object, default: None ) –

    optional, the parent of the sprite.

  • groups (LayeredDirty | None, default: None ) –

    optional, the sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.sprites.BitmappySprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.sprites.BitmappySprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.sprites.BitmappySprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.BitmappySprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.Singleton

A generic singleton class.

Attributes
glitchygames.sprites.Singleton.__instance__ class-attribute instance-attribute
__instance__ = None
Functions
glitchygames.sprites.Singleton.__new__
__new__(*args, **kwargs) -> Self

Create a new instance of the Singleton.

Parameters:
  • *args

    The arguments to pass to the constructor.

  • **kwargs

    The keyword arguments to pass to the constructor.

Returns:
  • Singleton( Self ) –

    The instance of the Singleton.

glitchygames.sprites.SingletonBitmappySprite

Bases: BitmappySprite

A singleton class for handling singleton sprites, like mouse pointers.

Attributes
glitchygames.sprites.SingletonBitmappySprite.rect instance-attribute
rect = get_rect()
glitchygames.sprites.SingletonBitmappySprite.image instance-attribute
image = Surface((width, height))
glitchygames.sprites.SingletonBitmappySprite.log class-attribute instance-attribute
log = LOG
glitchygames.sprites.SingletonBitmappySprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.sprites.SingletonBitmappySprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.sprites.SingletonBitmappySprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.sprites.SingletonBitmappySprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.sprites.SingletonBitmappySprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.sprites.SingletonBitmappySprite.dt instance-attribute
dt = 0
glitchygames.sprites.SingletonBitmappySprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.sprites.SingletonBitmappySprite.name instance-attribute
name = name
glitchygames.sprites.SingletonBitmappySprite.parent instance-attribute
parent = parent
glitchygames.sprites.SingletonBitmappySprite.proxies instance-attribute
proxies = [parent]
glitchygames.sprites.SingletonBitmappySprite.callbacks instance-attribute
callbacks = {}
glitchygames.sprites.SingletonBitmappySprite.screen instance-attribute
screen = get_surface()
glitchygames.sprites.SingletonBitmappySprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.sprites.SingletonBitmappySprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.sprites.SingletonBitmappySprite.width instance-attribute
width = width
glitchygames.sprites.SingletonBitmappySprite.height instance-attribute
height = height
glitchygames.sprites.SingletonBitmappySprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.sprites.SingletonBitmappySprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.sprites.SingletonBitmappySprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.sprites.SingletonBitmappySprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.sprites.SingletonBitmappySprite.filename instance-attribute
filename = filename
glitchygames.sprites.SingletonBitmappySprite.focusable instance-attribute
focusable = focusable
glitchygames.sprites.SingletonBitmappySprite.__instance__ class-attribute instance-attribute
__instance__ = None
Functions
glitchygames.sprites.SingletonBitmappySprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.sprites.SingletonBitmappySprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.sprites.SingletonBitmappySprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.sprites.SingletonBitmappySprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.sprites.SingletonBitmappySprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.sprites.SingletonBitmappySprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.sprites.SingletonBitmappySprite.__new__
__new__(*args, **kwargs) -> Self

Create a new instance of the SingletonBitmappySprite.

Parameters:
  • *args

    The arguments to pass to the constructor.

  • **kwargs

    The keyword arguments to pass to the constructor.

Returns:
  • SingletonBitmappySprite( Self ) –

    The instance of the SingletonBitmappySprite.

glitchygames.sprites.SingletonBitmappySprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize the SingletonBitmappySprite.

Parameters:
  • x (int) –

    The x coordinate of the sprite.

  • y (int) –

    The y coordinate of the sprite.

  • width (int) –

    The width of the sprite.

  • height (int) –

    The height of the sprite.

  • name (str, default: None ) –

    The name of the sprite.

  • groups (LayeredDirty, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite

Bases: BitmappySprite

A singleton class for handling all of the focusable sprite behaviors.

Attributes
glitchygames.sprites.FocusableSingletonBitmappySprite.rect instance-attribute
rect = get_rect()
glitchygames.sprites.FocusableSingletonBitmappySprite.image instance-attribute
image = Surface((width, height))
glitchygames.sprites.FocusableSingletonBitmappySprite.log class-attribute instance-attribute
log = LOG
glitchygames.sprites.FocusableSingletonBitmappySprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.sprites.FocusableSingletonBitmappySprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.sprites.FocusableSingletonBitmappySprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.sprites.FocusableSingletonBitmappySprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.sprites.FocusableSingletonBitmappySprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.sprites.FocusableSingletonBitmappySprite.dt instance-attribute
dt = 0
glitchygames.sprites.FocusableSingletonBitmappySprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.sprites.FocusableSingletonBitmappySprite.name instance-attribute
name = name
glitchygames.sprites.FocusableSingletonBitmappySprite.parent instance-attribute
parent = parent
glitchygames.sprites.FocusableSingletonBitmappySprite.proxies instance-attribute
proxies = [parent]
glitchygames.sprites.FocusableSingletonBitmappySprite.callbacks instance-attribute
callbacks = {}
glitchygames.sprites.FocusableSingletonBitmappySprite.screen instance-attribute
screen = get_surface()
glitchygames.sprites.FocusableSingletonBitmappySprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.sprites.FocusableSingletonBitmappySprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.sprites.FocusableSingletonBitmappySprite.width instance-attribute
width = width
glitchygames.sprites.FocusableSingletonBitmappySprite.height instance-attribute
height = height
glitchygames.sprites.FocusableSingletonBitmappySprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.sprites.FocusableSingletonBitmappySprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.sprites.FocusableSingletonBitmappySprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.sprites.FocusableSingletonBitmappySprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.sprites.FocusableSingletonBitmappySprite.filename instance-attribute
filename = filename
glitchygames.sprites.FocusableSingletonBitmappySprite.focusable instance-attribute
focusable = focusable
glitchygames.sprites.FocusableSingletonBitmappySprite.__instance__ class-attribute instance-attribute
__instance__ = None
Functions
glitchygames.sprites.FocusableSingletonBitmappySprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.sprites.FocusableSingletonBitmappySprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.sprites.FocusableSingletonBitmappySprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.sprites.FocusableSingletonBitmappySprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.sprites.FocusableSingletonBitmappySprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.sprites.FocusableSingletonBitmappySprite.__new__
__new__(*args, **kwargs) -> Self

Create a new instance of the FocusableSingletonBitmappySprite.

Parameters:
  • *args

    The arguments to pass to the constructor.

  • **kwargs

    The keyword arguments to pass to the constructor.

Returns:
  • FocusableSingletonBitmappySprite( Self ) –

    The instance of the FocusableSingletonBitmappySprite.

glitchygames.sprites.FocusableSingletonBitmappySprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize the FocusableSingletonBitmappySprite.

Parameters:
  • x (int) –

    The x coordinate of the sprite.

  • y (int) –

    The y coordinate of the sprite.

  • width (int) –

    The width of the sprite.

  • height (int) –

    The height of the sprite.

  • name (str, default: None ) –

    The name of the sprite.

  • groups (LayeredDirty, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

Functions

glitchygames.templates

This module helps build a project from templates. It's a wrapper around cookiecutter.

Attributes
glitchygames.templates.path module-attribute
path = parent
Functions
glitchygames.templates.get_templates
get_templates() -> list

Returns a list of templates.

glitchygames.templates.build
build(template: str) -> None

Builds the project from the template, using cookiecutter.

glitchygames.tools

Modules
glitchygames.tools.bitmappy

Glitchy Games Bitmap Editor.

Attributes
glitchygames.tools.bitmappy.LOG module-attribute
LOG = getLogger('game')
glitchygames.tools.bitmappy.MAX_PIXELS_ACROSS module-attribute
MAX_PIXELS_ACROSS = 64
glitchygames.tools.bitmappy.MIN_PIXELS_ACROSS module-attribute
MIN_PIXELS_ACROSS = 1
glitchygames.tools.bitmappy.MAX_PIXELS_TALL module-attribute
MAX_PIXELS_TALL = 64
glitchygames.tools.bitmappy.MIN_PIXELS_TALL module-attribute
MIN_PIXELS_TALL = 1
glitchygames.tools.bitmappy.MIN_COLOR_VALUE module-attribute
MIN_COLOR_VALUE = 0
glitchygames.tools.bitmappy.MAX_COLOR_VALUE module-attribute
MAX_COLOR_VALUE = 255
Classes
glitchygames.tools.bitmappy.GGUnhandledMenuItemError

Bases: Exception

Glitchy Games Unhandled Menu Item Error.

glitchygames.tools.bitmappy.InputConfirmationDialogScene

Bases: Scene

Input Confirmation Dialog Scene.

Attributes
glitchygames.tools.bitmappy.InputConfirmationDialogScene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.tools.bitmappy.InputConfirmationDialogScene.target_fps instance-attribute
target_fps = 0
glitchygames.tools.bitmappy.InputConfirmationDialogScene.fps instance-attribute
fps = 0
glitchygames.tools.bitmappy.InputConfirmationDialogScene.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.InputConfirmationDialogScene.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.InputConfirmationDialogScene.dirty instance-attribute
dirty = 1
glitchygames.tools.bitmappy.InputConfirmationDialogScene.options instance-attribute
options = options
glitchygames.tools.bitmappy.InputConfirmationDialogScene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.tools.bitmappy.InputConfirmationDialogScene.name instance-attribute
name = type(self)
glitchygames.tools.bitmappy.InputConfirmationDialogScene.next_scene instance-attribute
next_scene = self
glitchygames.tools.bitmappy.InputConfirmationDialogScene.rects instance-attribute
rects = None
glitchygames.tools.bitmappy.InputConfirmationDialogScene.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.InputConfirmationDialogScene.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.InputConfirmationDialogScene.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.InputConfirmationDialogScene.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.InputConfirmationDialogScene.background instance-attribute
background = Surface(get_size())
glitchygames.tools.bitmappy.InputConfirmationDialogScene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.tools.bitmappy.InputConfirmationDialogScene.image instance-attribute
image = screen
glitchygames.tools.bitmappy.InputConfirmationDialogScene.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.InputConfirmationDialogScene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.tools.bitmappy.InputConfirmationDialogScene.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.InputConfirmationDialogScene.NAME class-attribute instance-attribute
NAME = 'InputConfirmationDialog'
glitchygames.tools.bitmappy.InputConfirmationDialogScene.DIALOG_TEXT class-attribute instance-attribute
DIALOG_TEXT = 'Would you like to do a thing?'
glitchygames.tools.bitmappy.InputConfirmationDialogScene.CONFIRMATION_TEXT class-attribute instance-attribute
CONFIRMATION_TEXT = 'Confirm'
glitchygames.tools.bitmappy.InputConfirmationDialogScene.CANCEL_TEXT class-attribute instance-attribute
CANCEL_TEXT = 'Cancel'
glitchygames.tools.bitmappy.InputConfirmationDialogScene.VERSION class-attribute instance-attribute
VERSION = ''
glitchygames.tools.bitmappy.InputConfirmationDialogScene.previous_scene instance-attribute
previous_scene = previous_scene
glitchygames.tools.bitmappy.InputConfirmationDialogScene.dialog instance-attribute
dialog = InputDialog(
    name=NAME,
    dialog_text=DIALOG_TEXT,
    confirm_text=CONFIRMATION_TEXT,
    x=center[0] // 2,
    y=center[1] // 2,
    width=screen_width // 2,
    height=screen_height // 2,
    parent=self,
    groups=all_sprites,
)
Functions
glitchygames.tools.bitmappy.InputConfirmationDialogScene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.tools.bitmappy.InputConfirmationDialogScene.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.__init__
__init__(
    previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None

Initialize the Input Confirmation Dialog Scene.

Parameters:
  • previous_scene (Scene) –

    The previous scene.

  • options (dict, default: None ) –

    Options for the scene. Defaults to None.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.dismiss
dismiss() -> None

Dismiss the dialog.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_cancel_event
on_cancel_event(event: Event, trigger: object) -> None

Handle the cancel event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_confirm_event
on_confirm_event(event: Event, trigger: object) -> None

Handle the confirm event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_input_box_submit_event
on_input_box_submit_event(control: object) -> None

Handle the input box submit event.

Parameters:
  • control (object) –

    The control object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle the mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle the key up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.InputConfirmationDialogScene.on_key_down_event
on_key_down_event(event: Event) -> None

Handle the key down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene

Bases: InputConfirmationDialogScene

New Canvas Dialog Scene.

Attributes
glitchygames.tools.bitmappy.NewCanvasDialogScene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.tools.bitmappy.NewCanvasDialogScene.VERSION class-attribute instance-attribute
VERSION = ''
glitchygames.tools.bitmappy.NewCanvasDialogScene.target_fps instance-attribute
target_fps = 0
glitchygames.tools.bitmappy.NewCanvasDialogScene.fps instance-attribute
fps = 0
glitchygames.tools.bitmappy.NewCanvasDialogScene.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.NewCanvasDialogScene.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.NewCanvasDialogScene.dirty instance-attribute
dirty = 1
glitchygames.tools.bitmappy.NewCanvasDialogScene.options instance-attribute
options = options
glitchygames.tools.bitmappy.NewCanvasDialogScene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.tools.bitmappy.NewCanvasDialogScene.name instance-attribute
name = type(self)
glitchygames.tools.bitmappy.NewCanvasDialogScene.next_scene instance-attribute
next_scene = self
glitchygames.tools.bitmappy.NewCanvasDialogScene.rects instance-attribute
rects = None
glitchygames.tools.bitmappy.NewCanvasDialogScene.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.NewCanvasDialogScene.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.NewCanvasDialogScene.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.NewCanvasDialogScene.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.NewCanvasDialogScene.background instance-attribute
background = Surface(get_size())
glitchygames.tools.bitmappy.NewCanvasDialogScene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.tools.bitmappy.NewCanvasDialogScene.image instance-attribute
image = screen
glitchygames.tools.bitmappy.NewCanvasDialogScene.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.NewCanvasDialogScene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.tools.bitmappy.NewCanvasDialogScene.previous_scene instance-attribute
previous_scene = previous_scene
glitchygames.tools.bitmappy.NewCanvasDialogScene.dialog instance-attribute
dialog = InputDialog(
    name=NAME,
    dialog_text=DIALOG_TEXT,
    confirm_text=CONFIRMATION_TEXT,
    x=center[0] // 2,
    y=center[1] // 2,
    width=screen_width // 2,
    height=screen_height // 2,
    parent=self,
    groups=all_sprites,
)
glitchygames.tools.bitmappy.NewCanvasDialogScene.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.NewCanvasDialogScene.NAME class-attribute instance-attribute
NAME = 'New Canvas'
glitchygames.tools.bitmappy.NewCanvasDialogScene.DIALOG_TEXT class-attribute instance-attribute
DIALOG_TEXT = 'Are you sure you want to clear the canvas?'
glitchygames.tools.bitmappy.NewCanvasDialogScene.CONFIRMATION_TEXT class-attribute instance-attribute
CONFIRMATION_TEXT = 'Clear'
glitchygames.tools.bitmappy.NewCanvasDialogScene.CANCEL_TEXT class-attribute instance-attribute
CANCEL_TEXT = 'Cancel'
Functions
glitchygames.tools.bitmappy.NewCanvasDialogScene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle the mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_key_down_event
on_key_down_event(event: Event) -> None

Handle the key down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle the key up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.tools.bitmappy.NewCanvasDialogScene.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.dismiss
dismiss() -> None

Dismiss the dialog.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_cancel_event
on_cancel_event(event: Event, trigger: object) -> None

Handle the cancel event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_input_box_submit_event
on_input_box_submit_event(control: object) -> None

Handle the input box submit event.

Parameters:
  • control (object) –

    The control object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.__init__
__init__(
    previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None

Initialize the New Canvas Dialog Scene.

Parameters:
  • previous_scene (Scene) –

    The previous scene.

  • options (dict, default: None ) –

    Options for the scene. Defaults to None.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.NewCanvasDialogScene.on_confirm_event
on_confirm_event(event: Event, trigger: object) -> None

Handle the confirm event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene

Bases: InputConfirmationDialogScene

Load Dialog Scene.

Attributes
glitchygames.tools.bitmappy.LoadDialogScene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.tools.bitmappy.LoadDialogScene.target_fps instance-attribute
target_fps = 0
glitchygames.tools.bitmappy.LoadDialogScene.fps instance-attribute
fps = 0
glitchygames.tools.bitmappy.LoadDialogScene.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.LoadDialogScene.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.LoadDialogScene.dirty instance-attribute
dirty = 1
glitchygames.tools.bitmappy.LoadDialogScene.options instance-attribute
options = options
glitchygames.tools.bitmappy.LoadDialogScene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.tools.bitmappy.LoadDialogScene.name instance-attribute
name = type(self)
glitchygames.tools.bitmappy.LoadDialogScene.next_scene instance-attribute
next_scene = self
glitchygames.tools.bitmappy.LoadDialogScene.rects instance-attribute
rects = None
glitchygames.tools.bitmappy.LoadDialogScene.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.LoadDialogScene.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.LoadDialogScene.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.LoadDialogScene.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.LoadDialogScene.background instance-attribute
background = Surface(get_size())
glitchygames.tools.bitmappy.LoadDialogScene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.tools.bitmappy.LoadDialogScene.image instance-attribute
image = screen
glitchygames.tools.bitmappy.LoadDialogScene.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.LoadDialogScene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.tools.bitmappy.LoadDialogScene.previous_scene instance-attribute
previous_scene = previous_scene
glitchygames.tools.bitmappy.LoadDialogScene.dialog instance-attribute
dialog = InputDialog(
    name=NAME,
    dialog_text=DIALOG_TEXT,
    confirm_text=CONFIRMATION_TEXT,
    x=center[0] // 2,
    y=center[1] // 2,
    width=screen_width // 2,
    height=screen_height // 2,
    parent=self,
    groups=all_sprites,
)
glitchygames.tools.bitmappy.LoadDialogScene.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.LoadDialogScene.NAME class-attribute instance-attribute
NAME = 'Load Sprite'
glitchygames.tools.bitmappy.LoadDialogScene.DIALOG_TEXT class-attribute instance-attribute
DIALOG_TEXT = 'Would you like to load a sprite?'
glitchygames.tools.bitmappy.LoadDialogScene.CONFIRMATION_TEXT class-attribute instance-attribute
CONFIRMATION_TEXT = 'Load'
glitchygames.tools.bitmappy.LoadDialogScene.CANCEL_TEXT class-attribute instance-attribute
CANCEL_TEXT = 'Cancel'
glitchygames.tools.bitmappy.LoadDialogScene.VERSION class-attribute instance-attribute
VERSION = ''
Functions
glitchygames.tools.bitmappy.LoadDialogScene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.LoadDialogScene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle the mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_key_down_event
on_key_down_event(event: Event) -> None

Handle the key down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle the key up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.tools.bitmappy.LoadDialogScene.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.dismiss
dismiss() -> None

Dismiss the dialog.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_cancel_event
on_cancel_event(event: Event, trigger: object) -> None

Handle the cancel event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_input_box_submit_event
on_input_box_submit_event(control: object) -> None

Handle the input box submit event.

Parameters:
  • control (object) –

    The control object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.__init__
__init__(
    previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None

Initialize the Load Dialog Scene.

Parameters:
  • previous_scene (Scene) –

    The previous scene.

  • options (dict, default: None ) –

    Options for the scene. Defaults to None.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.LoadDialogScene.on_confirm_event
on_confirm_event(event: Event, trigger: object) -> None

Handle the confirm event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene

Bases: InputConfirmationDialogScene

Save Dialog Scene.

Attributes
glitchygames.tools.bitmappy.SaveDialogScene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.tools.bitmappy.SaveDialogScene.target_fps instance-attribute
target_fps = 0
glitchygames.tools.bitmappy.SaveDialogScene.fps instance-attribute
fps = 0
glitchygames.tools.bitmappy.SaveDialogScene.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.SaveDialogScene.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.SaveDialogScene.dirty instance-attribute
dirty = 1
glitchygames.tools.bitmappy.SaveDialogScene.options instance-attribute
options = options
glitchygames.tools.bitmappy.SaveDialogScene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.tools.bitmappy.SaveDialogScene.name instance-attribute
name = type(self)
glitchygames.tools.bitmappy.SaveDialogScene.next_scene instance-attribute
next_scene = self
glitchygames.tools.bitmappy.SaveDialogScene.rects instance-attribute
rects = None
glitchygames.tools.bitmappy.SaveDialogScene.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.SaveDialogScene.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.SaveDialogScene.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.SaveDialogScene.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.SaveDialogScene.background instance-attribute
background = Surface(get_size())
glitchygames.tools.bitmappy.SaveDialogScene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.tools.bitmappy.SaveDialogScene.image instance-attribute
image = screen
glitchygames.tools.bitmappy.SaveDialogScene.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.SaveDialogScene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.tools.bitmappy.SaveDialogScene.previous_scene instance-attribute
previous_scene = previous_scene
glitchygames.tools.bitmappy.SaveDialogScene.dialog instance-attribute
dialog = InputDialog(
    name=NAME,
    dialog_text=DIALOG_TEXT,
    confirm_text=CONFIRMATION_TEXT,
    x=center[0] // 2,
    y=center[1] // 2,
    width=screen_width // 2,
    height=screen_height // 2,
    parent=self,
    groups=all_sprites,
)
glitchygames.tools.bitmappy.SaveDialogScene.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.SaveDialogScene.NAME class-attribute instance-attribute
NAME = 'Save Sprite'
glitchygames.tools.bitmappy.SaveDialogScene.DIALOG_TEXT class-attribute instance-attribute
DIALOG_TEXT = 'Would you like to save your sprite?'
glitchygames.tools.bitmappy.SaveDialogScene.CONFIRMATION_TEXT class-attribute instance-attribute
CONFIRMATION_TEXT = 'Save'
glitchygames.tools.bitmappy.SaveDialogScene.CANCEL_TEXT class-attribute instance-attribute
CANCEL_TEXT = 'Cancel'
glitchygames.tools.bitmappy.SaveDialogScene.VERSION class-attribute instance-attribute
VERSION = ''
Functions
glitchygames.tools.bitmappy.SaveDialogScene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.SaveDialogScene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle the mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle right mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_key_down_event
on_key_down_event(event: Event) -> None

Handle the key down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle the key up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_menu_item_event cached
on_menu_item_event(event: Event) -> None

Handle menu item events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.tools.bitmappy.SaveDialogScene.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.dismiss
dismiss() -> None

Dismiss the dialog.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_cancel_event
on_cancel_event(event: Event, trigger: object) -> None

Handle the cancel event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_input_box_submit_event
on_input_box_submit_event(control: object) -> None

Handle the input box submit event.

Parameters:
  • control (object) –

    The control object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.__init__
__init__(
    previous_scene: Scene, options: dict | None = None, groups: LayeredDirty | None = None
) -> None

Initialize the Save Dialog Scene.

Parameters:
  • previous_scene (Scene) –

    The previous scene.

  • options (dict, default: None ) –

    Options for the scene. Defaults to None.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.SaveDialogScene.on_confirm_event
on_confirm_event(event: Event, trigger: object) -> None

Handle the confirm event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite

Bases: BitmappySprite

Bitmap Pixel Sprite.

Attributes
glitchygames.tools.bitmappy.BitmapPixelSprite.image instance-attribute
image = Surface((width, height))
glitchygames.tools.bitmappy.BitmapPixelSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.tools.bitmappy.BitmapPixelSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.tools.bitmappy.BitmapPixelSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.tools.bitmappy.BitmapPixelSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.tools.bitmappy.BitmapPixelSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.tools.bitmappy.BitmapPixelSprite.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.BitmapPixelSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.BitmapPixelSprite.name instance-attribute
name = name
glitchygames.tools.bitmappy.BitmapPixelSprite.parent instance-attribute
parent = parent
glitchygames.tools.bitmappy.BitmapPixelSprite.proxies instance-attribute
proxies = [parent]
glitchygames.tools.bitmappy.BitmapPixelSprite.callbacks instance-attribute
callbacks = {}
glitchygames.tools.bitmappy.BitmapPixelSprite.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.BitmapPixelSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.BitmapPixelSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.BitmapPixelSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.tools.bitmappy.BitmapPixelSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.tools.bitmappy.BitmapPixelSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.tools.bitmappy.BitmapPixelSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.tools.bitmappy.BitmapPixelSprite.filename instance-attribute
filename = filename
glitchygames.tools.bitmappy.BitmapPixelSprite.focusable instance-attribute
focusable = focusable
glitchygames.tools.bitmappy.BitmapPixelSprite.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.BitmapPixelSprite.PIXEL_CACHE class-attribute instance-attribute
PIXEL_CACHE: ClassVar = {}
glitchygames.tools.bitmappy.BitmapPixelSprite.pixel_number instance-attribute
pixel_number = pixel_number
glitchygames.tools.bitmappy.BitmapPixelSprite.pixel_width instance-attribute
pixel_width = width
glitchygames.tools.bitmappy.BitmapPixelSprite.pixel_height instance-attribute
pixel_height = height
glitchygames.tools.bitmappy.BitmapPixelSprite.border_thickness instance-attribute
border_thickness = border_thickness
glitchygames.tools.bitmappy.BitmapPixelSprite.width instance-attribute
width = pixel_width
glitchygames.tools.bitmappy.BitmapPixelSprite.height instance-attribute
height = pixel_height
glitchygames.tools.bitmappy.BitmapPixelSprite.color instance-attribute
color = (96, 96, 96)
glitchygames.tools.bitmappy.BitmapPixelSprite.x instance-attribute
x = x
glitchygames.tools.bitmappy.BitmapPixelSprite.y instance-attribute
y = y
glitchygames.tools.bitmappy.BitmapPixelSprite.rect instance-attribute
rect = rect(image, color, (x, y, width, height), border_thickness)
glitchygames.tools.bitmappy.BitmapPixelSprite.pixel_color property writable
pixel_color: tuple[int, int, int]

Get the pixel color.

Returns:
  • tuple[int, int, int]

    tuple[int, int, int]: The pixel color.

Functions
glitchygames.tools.bitmappy.BitmapPixelSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.tools.bitmappy.BitmapPixelSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.tools.bitmappy.BitmapPixelSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.tools.bitmappy.BitmapPixelSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.tools.bitmappy.BitmapPixelSprite.__init__
__init__(
    x: int = 0,
    y: int = 0,
    width: int = 1,
    height: int = 1,
    name: str | None = None,
    pixel_number: int = 0,
    border_thickness: int = 1,
    groups: LayeredDirty | None = None,
) -> None

Initialize the Bitmap Pixel Sprite.

Parameters:
  • x (int, default: 0 ) –

    The x coordinate. Defaults to 0.

  • y (int, default: 0 ) –

    The y coordinate. Defaults to 0.

  • width (int, default: 1 ) –

    The width. Defaults to 1.

  • height (int, default: 1 ) –

    The height. Defaults to 1.

  • name (str, default: None ) –

    The name. Defaults to None.

  • pixel_number (int, default: 0 ) –

    The pixel number. Defaults to 0.

  • border_thickness (int, default: 1 ) –

    The border thickness. Defaults to 1.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_pixel_update_event
on_pixel_update_event(event: Event) -> None

Handle the pixel update event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapPixelSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle the left mouse button down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas

Bases: BitmappySprite

Canvas.

Attributes
glitchygames.tools.bitmappy.Canvas.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.Canvas.image instance-attribute
image = Surface((width, height))
glitchygames.tools.bitmappy.Canvas.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.Canvas.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.tools.bitmappy.Canvas.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.tools.bitmappy.Canvas.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.tools.bitmappy.Canvas.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.tools.bitmappy.Canvas.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.tools.bitmappy.Canvas.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.Canvas.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.Canvas.name instance-attribute
name = name
glitchygames.tools.bitmappy.Canvas.parent instance-attribute
parent = parent
glitchygames.tools.bitmappy.Canvas.proxies instance-attribute
proxies = [parent]
glitchygames.tools.bitmappy.Canvas.callbacks instance-attribute
callbacks = {}
glitchygames.tools.bitmappy.Canvas.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.Canvas.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.Canvas.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.Canvas.width instance-attribute
width = width
glitchygames.tools.bitmappy.Canvas.height instance-attribute
height = height
glitchygames.tools.bitmappy.Canvas.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.tools.bitmappy.Canvas.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.tools.bitmappy.Canvas.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.tools.bitmappy.Canvas.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.tools.bitmappy.Canvas.filename instance-attribute
filename = filename
glitchygames.tools.bitmappy.Canvas.focusable instance-attribute
focusable = focusable
Functions
glitchygames.tools.bitmappy.Canvas.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.Canvas.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.tools.bitmappy.Canvas.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.tools.bitmappy.Canvas.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.tools.bitmappy.Canvas.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.tools.bitmappy.Canvas.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.tools.bitmappy.Canvas.__init__
__init__() -> None

Create a Canvas.

glitchygames.tools.bitmappy.Canvas.update
update() -> None

Update the canvas.

glitchygames.tools.bitmappy.CanvasSprite

Bases: BitmappySprite

Canvas Sprite.

Attributes
glitchygames.tools.bitmappy.CanvasSprite.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.CanvasSprite.image instance-attribute
image = Surface((width, height))
glitchygames.tools.bitmappy.CanvasSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.tools.bitmappy.CanvasSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.tools.bitmappy.CanvasSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.tools.bitmappy.CanvasSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.tools.bitmappy.CanvasSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.tools.bitmappy.CanvasSprite.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.CanvasSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.CanvasSprite.parent instance-attribute
parent = parent
glitchygames.tools.bitmappy.CanvasSprite.proxies instance-attribute
proxies = [parent]
glitchygames.tools.bitmappy.CanvasSprite.callbacks instance-attribute
callbacks = {}
glitchygames.tools.bitmappy.CanvasSprite.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.CanvasSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.CanvasSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.CanvasSprite.width instance-attribute
width = width
glitchygames.tools.bitmappy.CanvasSprite.height instance-attribute
height = height
glitchygames.tools.bitmappy.CanvasSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.tools.bitmappy.CanvasSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.tools.bitmappy.CanvasSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.tools.bitmappy.CanvasSprite.filename instance-attribute
filename = filename
glitchygames.tools.bitmappy.CanvasSprite.focusable instance-attribute
focusable = focusable
glitchygames.tools.bitmappy.CanvasSprite.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.CanvasSprite.WIDTH class-attribute instance-attribute
WIDTH = 32
glitchygames.tools.bitmappy.CanvasSprite.HEIGHT class-attribute instance-attribute
HEIGHT = 32
glitchygames.tools.bitmappy.CanvasSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.tools.bitmappy.CanvasSprite.PIXEL_CACHE class-attribute instance-attribute
PIXEL_CACHE: ClassVar = {}
glitchygames.tools.bitmappy.CanvasSprite.character_sprite instance-attribute
character_sprite = False
glitchygames.tools.bitmappy.CanvasSprite.border_thickness instance-attribute
border_thickness = 0
glitchygames.tools.bitmappy.CanvasSprite.border_margin instance-attribute
border_margin = 0
glitchygames.tools.bitmappy.CanvasSprite.pixels_across instance-attribute
pixels_across = WIDTH
glitchygames.tools.bitmappy.CanvasSprite.pixels_tall instance-attribute
pixels_tall = HEIGHT
glitchygames.tools.bitmappy.CanvasSprite.pixels instance-attribute
pixels = [(255, 0, 255)] * pixels_across * pixels_tall
glitchygames.tools.bitmappy.CanvasSprite.grid_line_width instance-attribute
grid_line_width = 0
glitchygames.tools.bitmappy.CanvasSprite.pixel_width instance-attribute
pixel_width = 1
glitchygames.tools.bitmappy.CanvasSprite.pixel_height instance-attribute
pixel_height = 1
glitchygames.tools.bitmappy.CanvasSprite.mini_view instance-attribute
mini_view = None
glitchygames.tools.bitmappy.CanvasSprite.resize_widget instance-attribute
resize_widget = None
glitchygames.tools.bitmappy.CanvasSprite.active_color instance-attribute
active_color = (255, 255, 255)
glitchygames.tools.bitmappy.CanvasSprite.name instance-attribute
name = 'Bitmap Canvas'
glitchygames.tools.bitmappy.CanvasSprite.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.CanvasSprite.pixel_boxes instance-attribute
pixel_boxes = [
    BitmapPixelSprite(
        name=f"pixel {i}", pixel_number=i, x=0, y=0, height=pixel_width, width=pixel_height
    )
    for i in range(pixels_across * pixels_tall)
]
glitchygames.tools.bitmappy.CanvasSprite.update_anyway instance-attribute
update_anyway = False
Functions
glitchygames.tools.bitmappy.CanvasSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.tools.bitmappy.CanvasSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.tools.bitmappy.CanvasSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.tools.bitmappy.CanvasSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.tools.bitmappy.CanvasSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str,
    has_mini_view: bool = True,
    groups: None | LayeredDirty = None,
) -> None

Initialize the Canvas Sprite.

Parameters:
  • x (int) –

    The x coordinate.

  • y (int) –

    The y coordinate.

  • width (int) –

    The width.

  • height (int) –

    The height.

  • name (str) –

    The name.

  • has_mini_view (bool, default: True ) –

    Whether or not to have a mini view. Defaults to True.

  • groups (None, default: None ) –

    Sprite groups. Defaults to None.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_pixel_update_event
on_pixel_update_event(event: Event, trigger: object) -> None

Handle the pixel update event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle the left mouse button down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle the left mouse drag event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_new_file_event
on_new_file_event(event: Event, trigger: object) -> None

Handle the new file event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_save_file_event
on_save_file_event(event: Event, trigger: object) -> None

Handle the save file event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.CanvasSprite.on_load_file_event
on_load_file_event(event: Event, trigger: object) -> None

Handle the load file event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView

Bases: CanvasSprite

Mini View.

Attributes
glitchygames.tools.bitmappy.MiniView.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.tools.bitmappy.MiniView.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.tools.bitmappy.MiniView.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.tools.bitmappy.MiniView.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.tools.bitmappy.MiniView.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.tools.bitmappy.MiniView.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.MiniView.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.MiniView.name instance-attribute
name = 'Bitmap Canvas'
glitchygames.tools.bitmappy.MiniView.parent instance-attribute
parent = parent
glitchygames.tools.bitmappy.MiniView.proxies instance-attribute
proxies = [parent]
glitchygames.tools.bitmappy.MiniView.callbacks instance-attribute
callbacks = {}
glitchygames.tools.bitmappy.MiniView.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.MiniView.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.MiniView.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.MiniView.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.tools.bitmappy.MiniView.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.tools.bitmappy.MiniView.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.tools.bitmappy.MiniView.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.tools.bitmappy.MiniView.filename instance-attribute
filename = filename
glitchygames.tools.bitmappy.MiniView.focusable instance-attribute
focusable = focusable
glitchygames.tools.bitmappy.MiniView.WIDTH class-attribute instance-attribute
WIDTH = 32
glitchygames.tools.bitmappy.MiniView.HEIGHT class-attribute instance-attribute
HEIGHT = 32
glitchygames.tools.bitmappy.MiniView.PIXEL_CACHE class-attribute instance-attribute
PIXEL_CACHE: ClassVar = {}
glitchygames.tools.bitmappy.MiniView.character_sprite instance-attribute
character_sprite = False
glitchygames.tools.bitmappy.MiniView.pixels_across instance-attribute
pixels_across = WIDTH
glitchygames.tools.bitmappy.MiniView.pixels_tall instance-attribute
pixels_tall = HEIGHT
glitchygames.tools.bitmappy.MiniView.pixel_boxes instance-attribute
pixel_boxes = [
    BitmapPixelSprite(
        name=f"pixel {i}", pixel_number=i, x=0, y=0, height=pixel_width, width=pixel_height
    )
    for i in range(pixels_across * pixels_tall)
]
glitchygames.tools.bitmappy.MiniView.pixel_width instance-attribute
pixel_width = 1
glitchygames.tools.bitmappy.MiniView.pixel_height instance-attribute
pixel_height = 1
glitchygames.tools.bitmappy.MiniView.mini_view instance-attribute
mini_view = None
glitchygames.tools.bitmappy.MiniView.resize_widget instance-attribute
resize_widget = None
glitchygames.tools.bitmappy.MiniView.active_color instance-attribute
active_color = (255, 255, 255)
glitchygames.tools.bitmappy.MiniView.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.MiniView.update_anyway instance-attribute
update_anyway = False
glitchygames.tools.bitmappy.MiniView.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.MiniView.pixels instance-attribute
pixels = pixels
glitchygames.tools.bitmappy.MiniView.width instance-attribute
width = pixels_across * pixel_width
glitchygames.tools.bitmappy.MiniView.height instance-attribute
height = pixels_tall * pixel_height
glitchygames.tools.bitmappy.MiniView.border_thickness instance-attribute
border_thickness = 0
glitchygames.tools.bitmappy.MiniView.border_margin instance-attribute
border_margin = 0
glitchygames.tools.bitmappy.MiniView.grid_line_width instance-attribute
grid_line_width = 0
glitchygames.tools.bitmappy.MiniView.image instance-attribute
image = Surface((width, height))
glitchygames.tools.bitmappy.MiniView.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.MiniView.color_palette instance-attribute
color_palette = [(0, 255, 0), (255, 0, 255), (255, 255, 0), (0, 0, 0)]
glitchygames.tools.bitmappy.MiniView.palette_index instance-attribute
palette_index = 0
glitchygames.tools.bitmappy.MiniView.dirty_pixels instance-attribute
dirty_pixels = [True] * len(pixels)
Functions
glitchygames.tools.bitmappy.MiniView.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.MiniView.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle the left mouse drag event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle the left mouse button down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.tools.bitmappy.MiniView.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.tools.bitmappy.MiniView.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.tools.bitmappy.MiniView.on_pixel_update_event
on_pixel_update_event(event: Event, trigger: object) -> None

Handle the pixel update event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_new_file_event
on_new_file_event(event: Event, trigger: object) -> None

Handle the new file event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_save_file_event
on_save_file_event(event: Event, trigger: object) -> None

Handle the save file event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_load_file_event
on_load_file_event(event: Event, trigger: object) -> None

Handle the load file event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.pixels_per_pixel staticmethod
pixels_per_pixel(pixels_across: int, pixels_tall: int) -> tuple[int, int]

Get the pixels per pixel.

Parameters:
  • pixels_across (int) –

    The pixels across.

  • pixels_tall (int) –

    The pixels tall.

Returns:
  • tuple[int, int]

    tuple[int, int]: The pixels per pixel.

glitchygames.tools.bitmappy.MiniView.__init__
__init__(
    x: int = 0,
    y: int = 0,
    width: int = 0,
    height: int = 0,
    name: str | None = None,
    border_thickness: int = 0,
    pixels: list | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize the Mini View.

Parameters:
  • x (int, default: 0 ) –

    The x coordinate. Defaults to 0.

  • y (int, default: 0 ) –

    The y coordinate. Defaults to 0.

  • width (int, default: 0 ) –

    The width. Defaults to 0.

  • height (int, default: 0 ) –

    The height. Defaults to 0.

  • name (str, default: None ) –

    The name. Defaults to None.

  • border_thickness (int, default: 0 ) –

    The border thickness. Defaults to 0.

  • pixels (list, default: None ) –

    The pixels. Defaults to None.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle the left mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.MiniView.__str__
__str__() -> str

Get the string representation of the Mini View.

Returns:
  • str( str ) –

    The string representation of the Mini View.

glitchygames.tools.bitmappy.BitmapEditorScene

Bases: Scene

Bitmap Editor Scene.

Attributes
glitchygames.tools.bitmappy.BitmapEditorScene.FPS class-attribute instance-attribute
FPS = 0
glitchygames.tools.bitmappy.BitmapEditorScene.target_fps instance-attribute
target_fps = 0
glitchygames.tools.bitmappy.BitmapEditorScene.fps instance-attribute
fps = 0
glitchygames.tools.bitmappy.BitmapEditorScene.dt instance-attribute
dt = 0
glitchygames.tools.bitmappy.BitmapEditorScene.dt_timer instance-attribute
dt_timer = 0
glitchygames.tools.bitmappy.BitmapEditorScene.dirty instance-attribute
dirty = 1
glitchygames.tools.bitmappy.BitmapEditorScene.options instance-attribute
options = options
glitchygames.tools.bitmappy.BitmapEditorScene.scene_manager instance-attribute
scene_manager = SceneManager()
glitchygames.tools.bitmappy.BitmapEditorScene.name instance-attribute
name = type(self)
glitchygames.tools.bitmappy.BitmapEditorScene.next_scene instance-attribute
next_scene = self
glitchygames.tools.bitmappy.BitmapEditorScene.rects instance-attribute
rects = None
glitchygames.tools.bitmappy.BitmapEditorScene.screen instance-attribute
screen = get_surface()
glitchygames.tools.bitmappy.BitmapEditorScene.screen_width instance-attribute
screen_width = get_width()
glitchygames.tools.bitmappy.BitmapEditorScene.screen_height instance-attribute
screen_height = get_height()
glitchygames.tools.bitmappy.BitmapEditorScene.all_sprites instance-attribute
all_sprites = groups
glitchygames.tools.bitmappy.BitmapEditorScene.background instance-attribute
background = Surface(get_size())
glitchygames.tools.bitmappy.BitmapEditorScene.background_color property writable
background_color: Color

Return the background color.

Returns:
  • Color

    pygame.Color: The background color.

glitchygames.tools.bitmappy.BitmapEditorScene.image instance-attribute
image = screen
glitchygames.tools.bitmappy.BitmapEditorScene.rect instance-attribute
rect = get_rect()
glitchygames.tools.bitmappy.BitmapEditorScene.screenshot property
screenshot: Surface

Return a screenshot of the scene.

Returns:
  • Surface

    pygame.Surface: The scene screenshot.

glitchygames.tools.bitmappy.BitmapEditorScene.log class-attribute instance-attribute
log = LOG
glitchygames.tools.bitmappy.BitmapEditorScene.NAME class-attribute instance-attribute
NAME = 'Bitmappy'
glitchygames.tools.bitmappy.BitmapEditorScene.VERSION class-attribute instance-attribute
VERSION = '1.0'
glitchygames.tools.bitmappy.BitmapEditorScene.menu_bar instance-attribute
menu_bar = MenuBar(name='Menu Bar', x=0, y=0, width=screen_width, height=20, groups=all_sprites)
glitchygames.tools.bitmappy.BitmapEditorScene.menu_icon instance-attribute
menu_icon = MenuItem(
    name=None, filename=parent / "resources" / "bitmappy.cfg", x=0, y=0, width=16, height=height
)
glitchygames.tools.bitmappy.BitmapEditorScene.canvas instance-attribute
canvas = CanvasSprite(
    name="Bitmap Canvas",
    x=0,
    y=32,
    width=int(screen_height * 0.75),
    height=int(screen_height * 0.75),
    groups=all_sprites,
)
glitchygames.tools.bitmappy.BitmapEditorScene.red_slider instance-attribute
red_slider = SliderSprite(
    name="R", x=10, y=screen_height - 70, width=256, height=slider_height, groups=all_sprites
)
glitchygames.tools.bitmappy.BitmapEditorScene.green_slider instance-attribute
green_slider = SliderSprite(
    name="G", x=10, y=screen_height - 50, width=256, height=slider_height, groups=all_sprites
)
glitchygames.tools.bitmappy.BitmapEditorScene.blue_slider instance-attribute
blue_slider = SliderSprite(
    name="B", x=10, y=screen_height - 30, width=256, height=slider_height, groups=all_sprites
)
glitchygames.tools.bitmappy.BitmapEditorScene.color_well instance-attribute
color_well = ColorWellSprite(
    name="Colorwell", x=midright[0] + 30, y=y, width=64, height=64, groups=groups
)
glitchygames.tools.bitmappy.BitmapEditorScene.new_canvas_dialog_scene instance-attribute
new_canvas_dialog_scene = NewCanvasDialogScene(options=options, previous_scene=self)
glitchygames.tools.bitmappy.BitmapEditorScene.load_dialog_scene instance-attribute
load_dialog_scene = LoadDialogScene(options=options, previous_scene=self)
glitchygames.tools.bitmappy.BitmapEditorScene.save_dialog_scene instance-attribute
save_dialog_scene = SaveDialogScene(options=options, previous_scene=self)
Functions
glitchygames.tools.bitmappy.BitmapEditorScene.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_close_event
on_window_close_event(event: Event) -> None

Handle window close events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_enter_event
on_window_enter_event(event: Event) -> None

Handle window enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_exposed_event
on_window_exposed_event(event: Event) -> None

Handle window exposed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_focus_gained_event
on_window_focus_gained_event(event: Event) -> None

Handle window focus gained events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_focus_lost_event
on_window_focus_lost_event(event: Event) -> None

Handle window focus lost events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_hidden_event
on_window_hidden_event(event: Event) -> None

Handle window hidden events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_hit_test_event
on_window_hit_test_event(event: Event) -> None

Handle window hit test events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_leave_event
on_window_leave_event(event: Event) -> None

Handle window leave events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_maximized_event
on_window_maximized_event(event: Event) -> None

Handle window maximized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_minimized_event
on_window_minimized_event(event: Event) -> None

Handle window minimized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_moved_event
on_window_moved_event(event: Event) -> None

Handle window moved events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_resized_event
on_window_resized_event(event: Event) -> None

Handle window resized events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_restored_event
on_window_restored_event(event: Event) -> None

Handle window restored events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_shown_event
on_window_shown_event(event: Event) -> None

Handle window shown events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_size_changed_event
on_window_size_changed_event(event: Event) -> None

Handle window size changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_window_take_focus_event
on_window_take_focus_event(event: Event) -> None

Handle window take focus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_text_editing_event
on_text_editing_event(event: Event) -> None

Handle text editing events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_text_input_event
on_text_input_event(event: Event) -> None

Handle text input events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_motion_event cached
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The event trigger.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_focus_event cached
on_mouse_focus_event(event: Event, entering_focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • entering_focus (object) –

    The object that is entering focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_unfocus_event cached
on_mouse_unfocus_event(event: Event, leaving_focus: object) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

  • leaving_focus (object) –

    The object that is leaving focus.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_button_up_event cached
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle middle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_button_down_event cached
on_mouse_button_down_event(event: Event) -> None

Handle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle middle mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle right mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_scroll_down_event cached
on_mouse_scroll_down_event(event: Event) -> None

Handle mouse scroll down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_scroll_up_event cached
on_mouse_scroll_up_event(event: Event) -> None

Handle mouse scroll up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_mouse_wheel_event cached
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_key_down_event cached
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_key_chord_up_event cached
on_key_chord_up_event(event: Event, keys: list) -> None

Handle key chord up events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_key_chord_down_event cached
on_key_chord_down_event(event: Event, keys: list) -> None

Handle key chord down events.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys in the chord.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_axis_motion_event cached
on_joy_axis_motion_event(event: Event) -> None

Handle joystick axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle joy button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle joy button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_hat_motion_event cached
on_joy_hat_motion_event(event: Event) -> None

Handle joystick hat motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_ball_motion_event cached
on_joy_ball_motion_event(event: Event) -> None

Handle joystick ball motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_device_added_event cached
on_joy_device_added_event(event: Event) -> None

Handle joystick device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_joy_device_removed_event cached
on_joy_device_removed_event(event: Event) -> None

Handle joystick device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_active_event cached
on_active_event(event: Event) -> None

Handle active events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_fps_event
on_fps_event(event: Event) -> None

Handle FPS events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_game_event cached
on_game_event(event: Event) -> None

Handle game events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle sys wm events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_user_event
on_user_event(event: Event) -> None

Handle user events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle video expose events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle video resize events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_quit_event
on_quit_event(event: Event) -> None

Handle quit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_font_changed_event cached
on_font_changed_event(event: Event) -> None

Handle font changed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_touch_down_event
on_touch_down_event(event: Event) -> None

Handle touch down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_touch_motion_event
on_touch_motion_event(event: Event) -> None

Handle touch motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_touch_up_event
on_touch_up_event(event: Event) -> None

Handle touch up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_multi_touch_down_event cached
on_multi_touch_down_event(event: Event) -> None

Handle multi finger down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_multi_touch_motion_event cached
on_multi_touch_motion_event(event: Event) -> None

Handle multi finger motion event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_multi_touch_up_event cached
on_multi_touch_up_event(event: Event) -> None

Handle multi finger up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_drop_begin_event cached
on_drop_begin_event(event: Event) -> None

Handle drop begin event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_drop_file_event cached
on_drop_file_event(event: Event) -> None

Handle drop file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_drop_text_event cached
on_drop_text_event(event: Event) -> None

Handle drop text event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_drop_complete_event cached
on_drop_complete_event(event: Event) -> None

Handle drop complete event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_axis_motion_event cached
on_controller_axis_motion_event(event: Event) -> None

Handle controller axis motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_button_down_event
on_controller_button_down_event(event: Event) -> None

Handle controller button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_button_up_event
on_controller_button_up_event(event: Event) -> None

Handle controller button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_device_added_event cached
on_controller_device_added_event(event: Event) -> None

Handle controller device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_device_remapped_event cached
on_controller_device_remapped_event(event: Event) -> None

Handle controller device remapped events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_device_removed_event cached
on_controller_device_removed_event(event: Event) -> None

Handle controller device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_touchpad_down_event cached
on_controller_touchpad_down_event(event: Event) -> None

Handle controller touchpad down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_touchpad_motion_event cached
on_controller_touchpad_motion_event(event: Event) -> None

Handle controller touchpad motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_controller_touchpad_up_event cached
on_controller_touchpad_up_event(event: Event) -> None

Handle controller touchpad up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_audio_device_added_event cached
on_audio_device_added_event(event: Event) -> None

Handle audio device added events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_audio_device_removed_event cached
on_audio_device_removed_event(event: Event) -> None

Handle audio device removed events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.setup
setup() -> None

Setup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.cleanup
cleanup() -> None

Cleanup the scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.dt_tick
dt_tick(dt: float) -> None

Update the scene's delta time.

Parameters:
  • dt (float) –

    The delta time to update.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.update
update() -> None

Update the active scene.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.render
render(screen: Surface) -> None

Render the active scene.

Parameters:
  • screen (Surface) –

    The screen to render to.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.sprites_at_position
sprites_at_position(pos: tuple) -> list[Sprite] | None

Return the sprites at a given position.

Parameters:
  • pos (tuple) –

    The position to check.

Returns:
  • list[Sprite] | None

    list[pygame.sprite.Sprite] | None: The sprites at the given position.

glitchygames.tools.bitmappy.BitmapEditorScene.load_resources
load_resources() -> None

Load the scene's resources.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.__init__
__init__(options: dict, groups: LayeredDirty | None = None) -> None

Initialize the Bitmap Editor Scene.

Parameters:
  • options (dict) –

    The options.

  • groups (LayeredDirty, default: None ) –

    Sprite groups. Defaults to pygame.sprite.LayeredDirty().

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_menu_item_event
on_menu_item_event(event: Event) -> None

Handle the menu item event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_new_file_event
on_new_file_event(event: Event) -> None

Handle the new file event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_new_canvas_dialog_event
on_new_canvas_dialog_event(event: Event) -> None

Handle the new canvas dialog event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_load_dialog_event
on_load_dialog_event(event: Event) -> None

Handle the load dialog event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_save_dialog_event
on_save_dialog_event(event: Event) -> None

Handle the save dialog event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_color_well_event
on_color_well_event(event: Event, trigger: object) -> None

Handle the color well event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_slider_event
on_slider_event(event: Event, trigger: object) -> None

Handle the slider event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle the right mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle the left mouse button down event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle the left mouse button up event.

Parameters:
  • event (Event) –

    The pygame event.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle the left mouse drag event.

Parameters:
  • event (Event) –

    The pygame event.

  • trigger (object) –

    The trigger object.

Returns:
  • None

    None

glitchygames.tools.bitmappy.BitmapEditorScene.args classmethod
args(parser: ArgumentParser) -> None

Add command line arguments.

Parameters:
  • parser (ArgumentParser) –

    The argument parser.

Returns:
  • None

    None

Functions
glitchygames.tools.bitmappy.main
main() -> None

Main function.

Returns:
  • None

    None

Modules

glitchygames.ui

GlitchyGames UI classes.

Attributes
glitchygames.ui.LOG module-attribute
LOG = getLogger('game.ui')
Classes
glitchygames.ui.MenuBar

Bases: FocusableSingletonBitmappySprite

A menu bar class.

Attributes
glitchygames.ui.MenuBar.rect instance-attribute
rect = get_rect()
glitchygames.ui.MenuBar.image instance-attribute
image = Surface((width, height))
glitchygames.ui.MenuBar.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.MenuBar.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.MenuBar.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.MenuBar.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.MenuBar.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.MenuBar.dt instance-attribute
dt = 0
glitchygames.ui.MenuBar.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.MenuBar.name instance-attribute
name = name
glitchygames.ui.MenuBar.parent instance-attribute
parent = parent
glitchygames.ui.MenuBar.proxies instance-attribute
proxies = [parent]
glitchygames.ui.MenuBar.callbacks instance-attribute
callbacks = {}
glitchygames.ui.MenuBar.screen instance-attribute
screen = get_surface()
glitchygames.ui.MenuBar.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.MenuBar.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.MenuBar.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.MenuBar.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.MenuBar.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.MenuBar.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.MenuBar.filename instance-attribute
filename = filename
glitchygames.ui.MenuBar.focusable instance-attribute
focusable = focusable
glitchygames.ui.MenuBar.__instance__ class-attribute instance-attribute
__instance__ = None
glitchygames.ui.MenuBar.log class-attribute instance-attribute
log = LOG
glitchygames.ui.MenuBar.all_sprites instance-attribute
all_sprites = groups
glitchygames.ui.MenuBar.background_color instance-attribute
background_color = (0, 255, 0)
glitchygames.ui.MenuBar.border_width instance-attribute
border_width = 2
glitchygames.ui.MenuBar.menu_items instance-attribute
menu_items = {}
glitchygames.ui.MenuBar.menu_offset_x instance-attribute
menu_offset_x = border_width
glitchygames.ui.MenuBar.menu_offset_y instance-attribute
menu_offset_y = border_width
glitchygames.ui.MenuBar.width instance-attribute
width = width
glitchygames.ui.MenuBar.height instance-attribute
height = height
glitchygames.ui.MenuBar.has_focus instance-attribute
has_focus = False
glitchygames.ui.MenuBar.dirty instance-attribute
dirty = 2
Functions
glitchygames.ui.MenuBar.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.MenuBar.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.MenuBar.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.MenuBar.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.MenuBar.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.MenuBar.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.MenuBar.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.MenuBar.__new__
__new__(*args, **kwargs) -> Self

Create a new instance of the FocusableSingletonBitmappySprite.

Parameters:
  • *args

    The arguments to pass to the constructor.

  • **kwargs

    The keyword arguments to pass to the constructor.

Returns:
  • FocusableSingletonBitmappySprite( Self ) –

    The instance of the FocusableSingletonBitmappySprite.

glitchygames.ui.MenuBar.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a MenuBar.

Parameters:
  • x (int) –

    The x coordinate of the menu bar.

  • y (int) –

    The y coordinate of the menu bar.

  • width (int) –

    The width of the menu bar.

  • height (int) –

    The height of the menu bar.

  • name (str | None, default: None ) –

    The name of the menu bar.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.MenuBar.add_menu
add_menu(menu: MenuItem) -> None

Add a menu to the menu bar.

Parameters:
Returns:
  • None

    None

glitchygames.ui.MenuBar.add_menu_item
add_menu_item(menu_item: MenuItem, menu: MenuBar | None = None) -> None

Add a menu item to the menu bar.

Parameters:
  • menu_item (MenuItem) –

    The menu item to add.

  • menu (MenuBar | None, default: None ) –

    The menu to add the menu item to.

Returns:
  • None

    None

glitchygames.ui.MenuBar.update
update() -> None

Update the menu bar.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle mouse enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle mouse exit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuBar.on_mouse_wheel_event
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem

Bases: BitmappySprite

A menu item class.

This class represents a menu item. It can be a root level menu item or a sub menu item.

Parameters:
Returns:
  • None

Attributes
glitchygames.ui.MenuItem.rect instance-attribute
rect = get_rect()
glitchygames.ui.MenuItem.image instance-attribute
image = Surface((width, height))
glitchygames.ui.MenuItem.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.MenuItem.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.MenuItem.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.MenuItem.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.MenuItem.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.MenuItem.dt instance-attribute
dt = 0
glitchygames.ui.MenuItem.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.MenuItem.proxies instance-attribute
proxies = [parent]
glitchygames.ui.MenuItem.callbacks instance-attribute
callbacks = {}
glitchygames.ui.MenuItem.screen instance-attribute
screen = get_surface()
glitchygames.ui.MenuItem.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.MenuItem.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.MenuItem.width instance-attribute
width = width
glitchygames.ui.MenuItem.height instance-attribute
height = height
glitchygames.ui.MenuItem.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.MenuItem.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.MenuItem.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.MenuItem.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.MenuItem.filename instance-attribute
filename = filename
glitchygames.ui.MenuItem.focusable instance-attribute
focusable = focusable
glitchygames.ui.MenuItem.log class-attribute instance-attribute
log = LOG
glitchygames.ui.MenuItem.all_sprites instance-attribute
all_sprites = groups
glitchygames.ui.MenuItem.background_color instance-attribute
background_color = (255, 0, 255)
glitchygames.ui.MenuItem.border_width instance-attribute
border_width = 2
glitchygames.ui.MenuItem.menu_items instance-attribute
menu_items = {}
glitchygames.ui.MenuItem.menu_offset_x instance-attribute
menu_offset_x = border_width
glitchygames.ui.MenuItem.menu_offset_y instance-attribute
menu_offset_y = border_width
glitchygames.ui.MenuItem.menu_image instance-attribute
menu_image = None
glitchygames.ui.MenuItem.menu_rect instance-attribute
menu_rect = None
glitchygames.ui.MenuItem.active instance-attribute
active = False
glitchygames.ui.MenuItem.name instance-attribute
name = name
glitchygames.ui.MenuItem.parent instance-attribute
parent = parent
glitchygames.ui.MenuItem.text instance-attribute
text = TextSprite(
    background_color=background_color,
    text_color=(0, 0, 0),
    x=x,
    y=y,
    width=width,
    height=height,
    text=name,
    parent=parent,
    groups=groups,
)
glitchygames.ui.MenuItem.menu_up_image instance-attribute
menu_up_image = image
glitchygames.ui.MenuItem.menu_up_rect instance-attribute
menu_up_rect = rect
glitchygames.ui.MenuItem.menu_down_image instance-attribute
menu_down_image = menu_up_image
glitchygames.ui.MenuItem.menu_down_rect instance-attribute
menu_down_rect = menu_up_rect
Functions
glitchygames.ui.MenuItem.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.MenuItem.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.MenuItem.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.MenuItem.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.MenuItem.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.MenuItem.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.MenuItem.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.MenuItem.__init__
__init__(
    x: int = 0,
    y: int = 0,
    width: int = 1,
    height: int = 1,
    name: str | None = None,
    filename: str | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a MenuItem.

Parameters:
  • x (int, default: 0 ) –

    The x coordinate of the menu item.

  • y (int, default: 0 ) –

    The y coordinate of the menu item.

  • width (int, default: 1 ) –

    The width of the menu item.

  • height (int, default: 1 ) –

    The height of the menu item.

  • name (str | None, default: None ) –

    The name of the menu item.

  • filename (str | None, default: None ) –

    The filename of the menu item.

  • parent (object | None, default: None ) –

    The parent of the menu item.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.MenuItem.add
add(*groups: LayeredDirty) -> None

Add the sprite to a group.

Parameters:
  • *groups (LayeredDirty, default: () ) –

    The groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.MenuItem.add_menu
add_menu(menu: MenuItem) -> None

Add a menu to the menu item.

Parameters:
Returns:
  • None

    None

glitchygames.ui.MenuItem.add_menu_item
add_menu_item(menu_item: MenuItem, menu: MenuBar) -> None

Add a menu item to the menu item.

Parameters:
  • menu_item (MenuItem) –

    The menu item to add.

  • menu (MenuBar) –

    The menu to add the menu item to.

Returns:
  • None

    None

glitchygames.ui.MenuItem.update
update() -> None

Update the menu item.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event) -> None

Handle left mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event) -> None

Handle middle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event) -> None

Handle middle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_drag_event
on_mouse_drag_event(event: Event) -> None

Handle mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_drop_event
on_mouse_drop_event(event: Event) -> None

Handle mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle mouse motion events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle mouse enter events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle mouse exit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event) -> None

Handle right mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event) -> None

Handle right mouse drop events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.MenuItem.on_mouse_wheel_event
on_mouse_wheel_event(event: Event) -> None

Handle mouse wheel events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite

Bases: BitmappySprite

A text sprite class.

Attributes
glitchygames.ui.TextSprite.rect instance-attribute
rect = get_rect()
glitchygames.ui.TextSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.TextSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.TextSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.TextSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.TextSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.TextSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.TextSprite.dt instance-attribute
dt = 0
glitchygames.ui.TextSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.TextSprite.name instance-attribute
name = name
glitchygames.ui.TextSprite.callbacks instance-attribute
callbacks = {}
glitchygames.ui.TextSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.TextSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.TextSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.TextSprite.width instance-attribute
width = width
glitchygames.ui.TextSprite.height instance-attribute
height = height
glitchygames.ui.TextSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.TextSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.TextSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.TextSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.TextSprite.filename instance-attribute
filename = filename
glitchygames.ui.TextSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.TextSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.TextSprite.background_color instance-attribute
background_color = (255, 0, 255)
glitchygames.ui.TextSprite.active_color instance-attribute
active_color = background_color
glitchygames.ui.TextSprite.click_color instance-attribute
click_color = (0, 255, 128)
glitchygames.ui.TextSprite.hover_color instance-attribute
hover_color = (255, 255, 0)
glitchygames.ui.TextSprite.text instance-attribute
text = text
glitchygames.ui.TextSprite.font_manager instance-attribute
font_manager = FontManager(GameEngine)
glitchygames.ui.TextSprite.alpha instance-attribute
alpha = 0
glitchygames.ui.TextSprite.parent instance-attribute
parent = parent
glitchygames.ui.TextSprite.text_box instance-attribute
text_box = TextBox(
    font=font(), x=x, y=x, text=text, text_color=text_color, parent=self, groups=groups
)
glitchygames.ui.TextSprite.proxies instance-attribute
proxies = [parent]
glitchygames.ui.TextSprite.x property writable
x: int

Get the x coordinate of the text sprite.

Returns:
  • int( int ) –

    The x coordinate of the text sprite.

glitchygames.ui.TextSprite.y property writable
y: int

Get the y coordinate of the text sprite.

Returns:
  • int( int ) –

    The y coordinate of the text sprite.

Classes
glitchygames.ui.TextSprite.TextBox

Bases: Sprite

A text box class.

Attributes
glitchygames.ui.TextSprite.TextBox.rect instance-attribute
rect = get_rect()
glitchygames.ui.TextSprite.TextBox.image instance-attribute
image = Surface((width, height))
glitchygames.ui.TextSprite.TextBox.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.TextSprite.TextBox.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.TextSprite.TextBox.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.TextSprite.TextBox.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.TextSprite.TextBox.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.TextSprite.TextBox.dt instance-attribute
dt = 0
glitchygames.ui.TextSprite.TextBox.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.TextSprite.TextBox.callbacks instance-attribute
callbacks = {}
glitchygames.ui.TextSprite.TextBox.screen instance-attribute
screen = get_surface()
glitchygames.ui.TextSprite.TextBox.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.TextSprite.TextBox.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.TextSprite.TextBox.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.ui.TextSprite.TextBox.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.ui.TextSprite.TextBox.log class-attribute instance-attribute
log = LOG
glitchygames.ui.TextSprite.TextBox.start_x instance-attribute
start_x = x
glitchygames.ui.TextSprite.TextBox.start_y instance-attribute
start_y = y
glitchygames.ui.TextSprite.TextBox.line_height instance-attribute
line_height = line_height
glitchygames.ui.TextSprite.TextBox.text_color instance-attribute
text_color = text_color
glitchygames.ui.TextSprite.TextBox.text_hover_color instance-attribute
text_hover_color = (255, 255, 255)
glitchygames.ui.TextSprite.TextBox.text_click_color instance-attribute
text_click_color = (63, 127, 255)
glitchygames.ui.TextSprite.TextBox.background_color instance-attribute
background_color = (255, 0, 255)
glitchygames.ui.TextSprite.TextBox.background_hover_color instance-attribute
background_hover_color = (0, 255, 128)
glitchygames.ui.TextSprite.TextBox.background_click_color instance-attribute
background_click_color = (255, 127, 63)
glitchygames.ui.TextSprite.TextBox.active_text_color instance-attribute
active_text_color = text_color
glitchygames.ui.TextSprite.TextBox.active_background_color instance-attribute
active_background_color = background_color
glitchygames.ui.TextSprite.TextBox.font instance-attribute
font = font
glitchygames.ui.TextSprite.TextBox.name instance-attribute
name = text
glitchygames.ui.TextSprite.TextBox.parent instance-attribute
parent = parent
glitchygames.ui.TextSprite.TextBox.proxies instance-attribute
proxies = [parent]
glitchygames.ui.TextSprite.TextBox.x property writable
x: int

Get the x coordinate of the text box.

Returns:
  • int( int ) –

    The x coordinate of the text box.

glitchygames.ui.TextSprite.TextBox.y property writable
y: int

Get the y coordinate of the text box.

Returns:
  • int( int ) –

    The y coordinate of the text box.

Functions
glitchygames.ui.TextSprite.TextBox.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.TextSprite.TextBox.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.TextSprite.TextBox.__init__
__init__(
    font: str,
    x: int,
    y: int,
    line_height: int = 15,
    text: str = "Text",
    text_color: tuple = WHITE,
    parent: object = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a TextBox.

Parameters:
  • font (str) –

    The font to use.

  • x (int) –

    The x coordinate of the text box.

  • y (int) –

    The y coordinate of the text box.

  • line_height (int, default: 15 ) –

    The line height of the text box.

  • text (str, default: 'Text' ) –

    The text to display in the text box.

  • text_color (tuple, default: WHITE ) –

    The color of the text.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.print_text
print_text(surface: Surface, string: str) -> None

Print text to the text box.

Parameters:
  • surface (Surface) –

    The surface to print the text to.

  • string (str) –

    The text to print.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.reset
reset() -> None

Reset the text box.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.indent
indent() -> None

Indent the text box.

Returns:
  • None

    None

glitchygames.ui.TextSprite.TextBox.unindent
unindent() -> None

Unindent the text box.

Returns:
  • None

    None

Functions
glitchygames.ui.TextSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.TextSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.TextSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.TextSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.TextSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.TextSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.TextSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.TextSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    background_color: tuple = BLACKLUCENT,
    text_color: tuple = WHITE,
    alpha: int = 0,
    text: str = "Text",
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a TextSprite.

Parameters:
  • x (int) –

    The x coordinate of the text sprite.

  • y (int) –

    The y coordinate of the text sprite.

  • width (int) –

    The width of the text sprite.

  • height (int) –

    The height of the text sprite.

  • name (str, default: None ) –

    The name of the text sprite.

  • background_color (tuple, default: BLACKLUCENT ) –

    The background color of the text sprite.

  • text_color (tuple, default: WHITE ) –

    The color of the text.

  • alpha (int, default: 0 ) –

    The alpha value of the text sprite.

  • text (str, default: 'Text' ) –

    The text to display in the text sprite.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.TextSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.ui.TextSprite.update
update() -> None

Update the text sprite.

Returns:
  • None

    None

glitchygames.ui.TextSprite.add
add(*groups: LayeredDirty) -> None

Add the sprite to a group.

Parameters:
  • *groups (LayeredDirty, default: () ) –

    The groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, focus: object) -> None

Handle mouse focus events.

Parameters:
  • event (Event) –

    The event to handle.

  • focus (object) –

    The object that has focus.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle mouse unfocus events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite

Bases: BitmappySprite

A button sprite class.

Attributes
glitchygames.ui.ButtonSprite.rect instance-attribute
rect = get_rect()
glitchygames.ui.ButtonSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.ButtonSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.ButtonSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.ButtonSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.ButtonSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.ButtonSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.ButtonSprite.dt instance-attribute
dt = 0
glitchygames.ui.ButtonSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.ButtonSprite.name instance-attribute
name = name
glitchygames.ui.ButtonSprite.parent instance-attribute
parent = parent
glitchygames.ui.ButtonSprite.proxies instance-attribute
proxies = [parent]
glitchygames.ui.ButtonSprite.callbacks instance-attribute
callbacks = {}
glitchygames.ui.ButtonSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.ButtonSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.ButtonSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.ButtonSprite.width instance-attribute
width = width
glitchygames.ui.ButtonSprite.height instance-attribute
height = height
glitchygames.ui.ButtonSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.ButtonSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.ButtonSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.ButtonSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.ButtonSprite.filename instance-attribute
filename = filename
glitchygames.ui.ButtonSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.ButtonSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.ButtonSprite.border_color instance-attribute
border_color = (255, 255, 255)
glitchygames.ui.ButtonSprite.active_color instance-attribute
active_color = (128, 128, 128)
glitchygames.ui.ButtonSprite.inactive_color instance-attribute
inactive_color = (0, 0, 0)
glitchygames.ui.ButtonSprite.background_color instance-attribute
background_color = inactive_color
glitchygames.ui.ButtonSprite.text instance-attribute
text = TextSprite(
    background_color=background_color,
    x=centerx if parent else x,
    y=centery if parent else y,
    width=width,
    height=height,
    text=name,
    parent=self,
    groups=groups,
)
glitchygames.ui.ButtonSprite.x property writable
x: int

Get the x coordinate of the button sprite.

Returns:
  • int( int ) –

    The x coordinate of the button sprite.

glitchygames.ui.ButtonSprite.y property writable
y: int

Get the y coordinate of the button sprite.

Returns:
  • int( int ) –

    The y coordinate of the button sprite.

Functions
glitchygames.ui.ButtonSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.ButtonSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.ButtonSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.ButtonSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.ButtonSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.ButtonSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a ButtonSprite.

Parameters:
  • x (int) –

    The x coordinate of the button sprite.

  • y (int) –

    The y coordinate of the button sprite.

  • width (int) –

    The width of the button sprite.

  • height (int) –

    The height of the button sprite.

  • name (str, default: None ) –

    The name of the button sprite.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Sets the dirty flag on the nested sprites.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ButtonSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite

Bases: ButtonSprite

A checkbox sprite class.

Attributes
glitchygames.ui.CheckboxSprite.rect instance-attribute
rect = get_rect()
glitchygames.ui.CheckboxSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.CheckboxSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.CheckboxSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.CheckboxSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.CheckboxSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.CheckboxSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.CheckboxSprite.dt instance-attribute
dt = 0
glitchygames.ui.CheckboxSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.CheckboxSprite.name instance-attribute
name = name
glitchygames.ui.CheckboxSprite.parent instance-attribute
parent = parent
glitchygames.ui.CheckboxSprite.proxies instance-attribute
proxies = [parent]
glitchygames.ui.CheckboxSprite.callbacks instance-attribute
callbacks = {}
glitchygames.ui.CheckboxSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.CheckboxSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.CheckboxSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.CheckboxSprite.width instance-attribute
width = width
glitchygames.ui.CheckboxSprite.height instance-attribute
height = height
glitchygames.ui.CheckboxSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.CheckboxSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.CheckboxSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.CheckboxSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.CheckboxSprite.filename instance-attribute
filename = filename
glitchygames.ui.CheckboxSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.CheckboxSprite.border_color instance-attribute
border_color = (255, 255, 255)
glitchygames.ui.CheckboxSprite.active_color instance-attribute
active_color = (128, 128, 128)
glitchygames.ui.CheckboxSprite.inactive_color instance-attribute
inactive_color = (0, 0, 0)
glitchygames.ui.CheckboxSprite.background_color instance-attribute
background_color = inactive_color
glitchygames.ui.CheckboxSprite.text instance-attribute
text = TextSprite(
    background_color=background_color,
    x=centerx if parent else x,
    y=centery if parent else y,
    width=width,
    height=height,
    text=name,
    parent=self,
    groups=groups,
)
glitchygames.ui.CheckboxSprite.x property writable
x: int

Get the x coordinate of the button sprite.

Returns:
  • int( int ) –

    The x coordinate of the button sprite.

glitchygames.ui.CheckboxSprite.y property writable
y: int

Get the y coordinate of the button sprite.

Returns:
  • int( int ) –

    The y coordinate of the button sprite.

glitchygames.ui.CheckboxSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.CheckboxSprite.checked instance-attribute
checked = False
glitchygames.ui.CheckboxSprite.color instance-attribute
color = (128, 128, 128)
Functions
glitchygames.ui.CheckboxSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.CheckboxSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.CheckboxSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.CheckboxSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.CheckboxSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.CheckboxSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Sets the dirty flag on the nested sprites.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    callbacks: Callable | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a CheckboxSprite.

Parameters:
  • x (int) –

    The x coordinate of the checkbox sprite.

  • y (int) –

    The y coordinate of the checkbox sprite.

  • width (int) –

    The width of the checkbox sprite.

  • height (int) –

    The height of the checkbox sprite.

  • name (str, default: None ) –

    The name of the checkbox sprite.

  • callbacks (Callable, default: None ) –

    The callbacks to call when events occur.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.update
update() -> None

Update the checkbox sprite.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.CheckboxSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox

Bases: Sprite

An input box class.

Attributes
glitchygames.ui.InputBox.log class-attribute instance-attribute
log = LOG
glitchygames.ui.InputBox.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.InputBox.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.InputBox.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.InputBox.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.InputBox.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.InputBox.dt instance-attribute
dt = 0
glitchygames.ui.InputBox.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.InputBox.name instance-attribute
name = name
glitchygames.ui.InputBox.proxies instance-attribute
proxies = [self]
glitchygames.ui.InputBox.callbacks instance-attribute
callbacks = {}
glitchygames.ui.InputBox.screen instance-attribute
screen = get_surface()
glitchygames.ui.InputBox.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.InputBox.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.InputBox.width property writable
width: int

Return the width of the sprite.

Returns:
  • int( int ) –

    The width of the sprite.

glitchygames.ui.InputBox.height property writable
height: int

Return the height of the sprite.

Returns:
  • int( int ) –

    The height of the sprite.

glitchygames.ui.InputBox.offset_x instance-attribute
offset_x = x if parent else 0
glitchygames.ui.InputBox.offset_y instance-attribute
offset_y = y if parent else 0
glitchygames.ui.InputBox.rect instance-attribute
rect = Rect(x, y, width, height)
glitchygames.ui.InputBox.color instance-attribute
color = color
glitchygames.ui.InputBox.font instance-attribute
font = SysFont('Times', 14)
glitchygames.ui.InputBox.text instance-attribute
text = text
glitchygames.ui.InputBox.text_image instance-attribute
text_image = render(text, True, color)
glitchygames.ui.InputBox.active instance-attribute
active = False
glitchygames.ui.InputBox.image instance-attribute
image = Surface((width, height))
glitchygames.ui.InputBox.parent instance-attribute
parent = parent
glitchygames.ui.InputBox.cursor_rect instance-attribute
cursor_rect = get_rect()
glitchygames.ui.InputBox.cursor instance-attribute
cursor = Rect(topright, (3, height))
glitchygames.ui.InputBox.dirty instance-attribute
dirty = 2
Functions
glitchygames.ui.InputBox.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.InputBox.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.InputBox.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.InputBox.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    color: tuple = (233, 248, 215),
    text: str = "",
    name: str | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize an InputBox.

Parameters:
  • x (int) –

    The x coordinate of the input box.

  • y (int) –

    The y coordinate of the input box.

  • width (int) –

    The width of the input box.

  • height (int) –

    The height of the input box.

  • color (tuple, default: (233, 248, 215) ) –

    The color of the input box.

  • text (str, default: '' ) –

    The text to display in the input box.

  • name (str, default: None ) –

    The name of the input box.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.InputBox.activate
activate() -> None

Activate the input box.

Returns:
  • None

    None

glitchygames.ui.InputBox.deactivate
deactivate() -> None

Deactivate the input box.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_input_box_submit_event
on_input_box_submit_event(event: Event) -> None

Handle input box submit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.update
update() -> None

Update the input box.

Returns:
  • None

    None

glitchygames.ui.InputBox.render
render() -> None

Render the input box.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_mouse_up_event
on_mouse_up_event(event: Event) -> None

Handle mouse up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputBox.on_key_down_event
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite

Bases: BitmappySprite

A text box sprite class.

Attributes
glitchygames.ui.TextBoxSprite.rect instance-attribute
rect = get_rect()
glitchygames.ui.TextBoxSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.TextBoxSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.TextBoxSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.TextBoxSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.TextBoxSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.TextBoxSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.TextBoxSprite.dt instance-attribute
dt = 0
glitchygames.ui.TextBoxSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.TextBoxSprite.name instance-attribute
name = name
glitchygames.ui.TextBoxSprite.parent instance-attribute
parent = parent
glitchygames.ui.TextBoxSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.TextBoxSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.TextBoxSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.TextBoxSprite.width instance-attribute
width = width
glitchygames.ui.TextBoxSprite.height instance-attribute
height = height
glitchygames.ui.TextBoxSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.TextBoxSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.TextBoxSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.TextBoxSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.TextBoxSprite.filename instance-attribute
filename = filename
glitchygames.ui.TextBoxSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.TextBoxSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.TextBoxSprite.value instance-attribute
value = None
glitchygames.ui.TextBoxSprite.background_color instance-attribute
background_color = (0, 0, 0)
glitchygames.ui.TextBoxSprite.border_width instance-attribute
border_width = 1
glitchygames.ui.TextBoxSprite.callbacks instance-attribute
callbacks = callbacks
glitchygames.ui.TextBoxSprite.text_box instance-attribute
text_box = TextSprite(
    background_color=background_color,
    x=x,
    y=y,
    width=width - border_width,
    height=height - border_width,
    text=value,
    parent=self,
    groups=groups,
)
glitchygames.ui.TextBoxSprite.x instance-attribute
x = x
glitchygames.ui.TextBoxSprite.y instance-attribute
y = y
glitchygames.ui.TextBoxSprite.proxies instance-attribute
proxies = [parent]
Functions
glitchygames.ui.TextBoxSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.TextBoxSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.TextBoxSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.TextBoxSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.TextBoxSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.TextBoxSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    callbacks: Callable | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a TextBoxSprite.

Parameters:
  • x (int) –

    The x coordinate of the text box sprite.

  • y (int) –

    The y coordinate of the text box sprite.

  • width (int) –

    The width of the text box sprite.

  • height (int) –

    The height of the text box sprite.

  • name (str, default: None ) –

    The name of the text box sprite.

  • callbacks (Callable, default: None ) –

    The callbacks to call when events occur.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.update
update() -> None

Update the text box sprite.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.TextBoxSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle left mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite

Bases: BitmappySprite

A slider sprite class.

Attributes
glitchygames.ui.SliderSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.SliderSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.SliderSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.SliderSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.SliderSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.SliderSprite.dt instance-attribute
dt = 0
glitchygames.ui.SliderSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.SliderSprite.name instance-attribute
name = name
glitchygames.ui.SliderSprite.parent instance-attribute
parent = parent
glitchygames.ui.SliderSprite.proxies instance-attribute
proxies = [parent]
glitchygames.ui.SliderSprite.callbacks instance-attribute
callbacks = {}
glitchygames.ui.SliderSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.SliderSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.SliderSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.SliderSprite.width instance-attribute
width = width
glitchygames.ui.SliderSprite.height instance-attribute
height = height
glitchygames.ui.SliderSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.SliderSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.SliderSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.SliderSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.SliderSprite.filename instance-attribute
filename = filename
glitchygames.ui.SliderSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.SliderSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.SliderSprite.text_sprite instance-attribute
text_sprite = TextSprite(
    x=257, y=y, width=40, height=16, name=str((0, 0, 0)), parent=self, groups=groups
)
glitchygames.ui.SliderSprite.slider_knob instance-attribute
slider_knob = SliderKnobSprite(
    x=x,
    y=y - 1,
    width=height * 2 - 1,
    height=height * 2 - 1,
    name=name,
    parent=self,
    groups=groups,
)
glitchygames.ui.SliderSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.SliderSprite.rect instance-attribute
rect = get_rect()
glitchygames.ui.SliderSprite.background instance-attribute
background = Surface((width, height))
glitchygames.ui.SliderSprite.value property writable
value: int

Get the value of the slider sprite.

Returns:
  • int( int ) –

    The value of the slider sprite.

glitchygames.ui.SliderSprite.x property writable
x: int

Get the x coordinate of the slider sprite.

Returns:
  • int( int ) –

    The x coordinate of the slider sprite.

glitchygames.ui.SliderSprite.y property writable
y: int

Get the y coordinate of the slider sprite.

Returns:
  • int( int ) –

    The y coordinate of the slider sprite.

Classes
glitchygames.ui.SliderSprite.SliderKnobSprite

Bases: BitmappySprite

A slider knob sprite class.

Attributes
glitchygames.ui.SliderSprite.SliderKnobSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.SliderSprite.SliderKnobSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.SliderSprite.SliderKnobSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.SliderSprite.SliderKnobSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.SliderSprite.SliderKnobSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.SliderSprite.SliderKnobSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.SliderSprite.SliderKnobSprite.dt instance-attribute
dt = 0
glitchygames.ui.SliderSprite.SliderKnobSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.SliderSprite.SliderKnobSprite.name instance-attribute
name = name
glitchygames.ui.SliderSprite.SliderKnobSprite.parent instance-attribute
parent = parent
glitchygames.ui.SliderSprite.SliderKnobSprite.proxies instance-attribute
proxies = [parent]
glitchygames.ui.SliderSprite.SliderKnobSprite.callbacks instance-attribute
callbacks = {}
glitchygames.ui.SliderSprite.SliderKnobSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.SliderSprite.SliderKnobSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.SliderSprite.SliderKnobSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.SliderSprite.SliderKnobSprite.width instance-attribute
width = width
glitchygames.ui.SliderSprite.SliderKnobSprite.height instance-attribute
height = height
glitchygames.ui.SliderSprite.SliderKnobSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.SliderSprite.SliderKnobSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.SliderSprite.SliderKnobSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.SliderSprite.SliderKnobSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.SliderSprite.SliderKnobSprite.filename instance-attribute
filename = filename
glitchygames.ui.SliderSprite.SliderKnobSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.SliderSprite.SliderKnobSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.SliderSprite.SliderKnobSprite.value instance-attribute
value = 0
glitchygames.ui.SliderSprite.SliderKnobSprite.rect instance-attribute
rect = Rect(x, y, width, height)
glitchygames.ui.SliderSprite.SliderKnobSprite.x instance-attribute
x = x
glitchygames.ui.SliderSprite.SliderKnobSprite.y instance-attribute
y = y
Functions
glitchygames.ui.SliderSprite.SliderKnobSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.update
update() -> None

Update the sprite.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.SliderSprite.SliderKnobSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.SliderSprite.SliderKnobSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.SliderSprite.SliderKnobSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.SliderSprite.SliderKnobSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a SliderKnobSprite.

Parameters:
  • x (int) –

    The x coordinate of the slider knob sprite.

  • y (int) –

    The y coordinate of the slider knob sprite.

  • width (int) –

    The width of the slider knob sprite.

  • height (int) –

    The height of the slider knob sprite.

  • name (str, default: None ) –

    The name of the slider knob sprite.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.SliderKnobSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

Functions
glitchygames.ui.SliderSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.SliderSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.SliderSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.SliderSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.SliderSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.SliderSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a SliderSprite.

Parameters:
  • x (int) –

    The x coordinate of the slider sprite.

  • y (int) –

    The y coordinate of the slider sprite.

  • width (int) –

    The width of the slider sprite.

  • height (int) –

    The height of the slider sprite.

  • name (str, default: None ) –

    The name of the slider sprite.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.update
update() -> None

Update the slider sprite.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle left mouse button down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.SliderSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object) -> None

Handle left mouse drag events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite

Bases: BitmappySprite

A color well sprite class.

Attributes
glitchygames.ui.ColorWellSprite.rect instance-attribute
rect = get_rect()
glitchygames.ui.ColorWellSprite.image instance-attribute
image = Surface((width, height))
glitchygames.ui.ColorWellSprite.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.ColorWellSprite.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.ColorWellSprite.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.ColorWellSprite.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.ColorWellSprite.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.ColorWellSprite.dt instance-attribute
dt = 0
glitchygames.ui.ColorWellSprite.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.ColorWellSprite.name instance-attribute
name = name
glitchygames.ui.ColorWellSprite.parent instance-attribute
parent = parent
glitchygames.ui.ColorWellSprite.proxies instance-attribute
proxies = [parent]
glitchygames.ui.ColorWellSprite.callbacks instance-attribute
callbacks = {}
glitchygames.ui.ColorWellSprite.screen instance-attribute
screen = get_surface()
glitchygames.ui.ColorWellSprite.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.ColorWellSprite.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.ColorWellSprite.width instance-attribute
width = width
glitchygames.ui.ColorWellSprite.height instance-attribute
height = height
glitchygames.ui.ColorWellSprite.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.ColorWellSprite.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.ColorWellSprite.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.ColorWellSprite.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.ColorWellSprite.filename instance-attribute
filename = filename
glitchygames.ui.ColorWellSprite.focusable instance-attribute
focusable = focusable
glitchygames.ui.ColorWellSprite.log class-attribute instance-attribute
log = LOG
glitchygames.ui.ColorWellSprite.red instance-attribute
red = 0
glitchygames.ui.ColorWellSprite.green instance-attribute
green = 0
glitchygames.ui.ColorWellSprite.blue instance-attribute
blue = 0
glitchygames.ui.ColorWellSprite.text_sprite instance-attribute
text_sprite = TextBoxSprite(
    x=midleft[0] + width,
    y=centery - 10,
    width=100,
    height=20,
    name=str(active_color),
    parent=self,
    groups=groups,
)
glitchygames.ui.ColorWellSprite.active_color property writable
active_color: tuple[int, int, int]

Get the active color.

Returns:
  • tuple[int, int, int]

    tuple[R: int, G: int, B: int]: The active color.

glitchygames.ui.ColorWellSprite.hex_color property
hex_color: str

Get the hex color.

Returns:
  • str( str ) –

    The hex color in #RRGGBB format.

Functions
glitchygames.ui.ColorWellSprite.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.ColorWellSprite.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle a mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_key_down_event
on_key_down_event(event: Event) -> None

Handle a key down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_key_up_event
on_key_up_event(event: Event) -> None

Handle a key up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.ColorWellSprite.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.ColorWellSprite.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.ColorWellSprite.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.ColorWellSprite.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str,
    parent: object | None = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize a ColorWellSprite.

Parameters:
  • x (int) –

    The x coordinate of the color well sprite.

  • y (int) –

    The y coordinate of the color well sprite.

  • width (int) –

    The width of the color well sprite.

  • height (int) –

    The height of the color well sprite.

  • name (str) –

    The name of the color well sprite.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.ui.ColorWellSprite.update
update() -> None

Update the color well sprite.

Returns:
  • None

    None

glitchygames.ui.InputDialog

Bases: BitmappySprite

An input dialog class.

Attributes
glitchygames.ui.InputDialog.rect instance-attribute
rect = get_rect()
glitchygames.ui.InputDialog.image instance-attribute
image = Surface((width, height))
glitchygames.ui.InputDialog.USE_GFXDRAW class-attribute instance-attribute
USE_GFXDRAW: ClassVar = False
glitchygames.ui.InputDialog.PROXIES class-attribute instance-attribute
PROXIES: ClassVar = [sprite]
glitchygames.ui.InputDialog.SPRITE_BREAKPOINTS class-attribute instance-attribute
SPRITE_BREAKPOINTS: ClassVar = None
glitchygames.ui.InputDialog.SPRITE_COUNTERS class-attribute instance-attribute
SPRITE_COUNTERS: ClassVar = OrderedDict()
glitchygames.ui.InputDialog.SPRITE_COUNT class-attribute instance-attribute
SPRITE_COUNT = 0
glitchygames.ui.InputDialog.dt instance-attribute
dt = 0
glitchygames.ui.InputDialog.dt_timer instance-attribute
dt_timer = 0
glitchygames.ui.InputDialog.name instance-attribute
name = name
glitchygames.ui.InputDialog.parent instance-attribute
parent = parent
glitchygames.ui.InputDialog.proxies instance-attribute
proxies = [parent]
glitchygames.ui.InputDialog.callbacks instance-attribute
callbacks = {}
glitchygames.ui.InputDialog.screen instance-attribute
screen = get_surface()
glitchygames.ui.InputDialog.screen_width instance-attribute
screen_width = get_width()
glitchygames.ui.InputDialog.screen_height instance-attribute
screen_height = get_height()
glitchygames.ui.InputDialog.height instance-attribute
height = height
glitchygames.ui.InputDialog.DEBUG class-attribute instance-attribute
DEBUG = False
glitchygames.ui.InputDialog.DEFAULT_SURFACE_W class-attribute instance-attribute
DEFAULT_SURFACE_W = 42
glitchygames.ui.InputDialog.DEFAULT_SURFACE_H class-attribute instance-attribute
DEFAULT_SURFACE_H = 42
glitchygames.ui.InputDialog.DEFAULT_SURFACE class-attribute instance-attribute
DEFAULT_SURFACE = Surface((DEFAULT_SURFACE_W, DEFAULT_SURFACE_H))
glitchygames.ui.InputDialog.filename instance-attribute
filename = filename
glitchygames.ui.InputDialog.focusable instance-attribute
focusable = focusable
glitchygames.ui.InputDialog.log class-attribute instance-attribute
log = LOG
glitchygames.ui.InputDialog.background_color instance-attribute
background_color = (0, 0, 0)
glitchygames.ui.InputDialog.border_width instance-attribute
border_width = 1
glitchygames.ui.InputDialog.width instance-attribute
width = width
glitchygames.ui.InputDialog.dialog_text_sprite instance-attribute
dialog_text_sprite = TextBoxSprite(
    name=dialog_text, x=x, y=y, width=width // 2, height=20, parent=self, groups=groups
)
glitchygames.ui.InputDialog.confirm_button instance-attribute
confirm_button = ButtonSprite(name=confirm_text, x=x, y=y, width=75, height=20, groups=groups)
glitchygames.ui.InputDialog.cancel_button instance-attribute
cancel_button = ButtonSprite(name=cancel_text, x=x, y=y, width=75, height=20, groups=groups)
glitchygames.ui.InputDialog.input_box instance-attribute
input_box = InputBox(
    x=x + width // 2, y=y + height // 2, width=200, height=20, text="", parent=self, groups=groups
)
Functions
glitchygames.ui.InputDialog.__subclasshook__ classmethod
__subclasshook__(subclass: object) -> bool

Override the default subclasshook to create an interface.

glitchygames.ui.InputDialog.on_mouse_motion_event
on_mouse_motion_event(event: Event) -> None

Handle a mouse motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_drag_event
on_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_drop_event
on_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_left_mouse_drag_event
on_left_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_left_mouse_drop_event
on_left_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a left mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_middle_mouse_drag_event
on_middle_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_middle_mouse_drop_event
on_middle_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_right_mouse_drag_event
on_right_mouse_drag_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_right_mouse_drop_event
on_right_mouse_drop_event(event: Event, trigger: object | None) -> None

Handle a right mouse drop event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_focus_event
on_mouse_focus_event(event: Event, old_focus: object) -> None

Handle a mouse focus event.

Parameters:
  • event (Event) –

    The event to handle.

  • old_focus (object) –

    The old focus.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_unfocus_event
on_mouse_unfocus_event(event: Event) -> None

Handle a mouse unfocus event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_left_mouse_button_up_event
on_left_mouse_button_up_event(event: Event) -> None

Handle a left mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_middle_mouse_button_up_event
on_middle_mouse_button_up_event(event: Event) -> None

Handle a middle mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_right_mouse_button_up_event
on_right_mouse_button_up_event(event: Event) -> None

Handle a right mouse button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_button_down_event
on_mouse_button_down_event(event: Event) -> None

Handle a mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_left_mouse_button_down_event
on_left_mouse_button_down_event(event: Event) -> None

Handle a left mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_middle_mouse_button_down_event
on_middle_mouse_button_down_event(event: Event) -> None

Handle a middle mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_right_mouse_button_down_event
on_right_mouse_button_down_event(event: Event) -> None

Handle a right mouse button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_scroll_down_event
on_mouse_scroll_down_event(event: Event) -> None

Handle a mouse scroll down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_scroll_up_event
on_mouse_scroll_up_event(event: Event) -> None

Handle a mouse scroll up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_wheel_event
on_mouse_wheel_event(event: Event, trigger: object | None) -> None

Handle a mouse wheel event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.break_when classmethod
break_when(sprite_type: object | None = None) -> None

Register a breakpoint for a sprite type.

Parameters:
  • sprite_type (object | None, default: None ) –

    The sprite type to break on.

Returns:
  • None

    None

glitchygames.ui.InputDialog.dt_tick
dt_tick(dt: float) -> None

Update the sprite's delta time.

Parameters:
  • dt (float) –

    The new delta time.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_joy_axis_motion_event
on_joy_axis_motion_event(event: Event) -> None

Handle a joystick axis motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_joy_button_down_event
on_joy_button_down_event(event: Event) -> None

Handle a joystick button down event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_joy_button_up_event
on_joy_button_up_event(event: Event) -> None

Handle a joystick button up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_joy_hat_motion_event
on_joy_hat_motion_event(event: Event) -> None

Handle a joystick hat motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_joy_ball_motion_event
on_joy_ball_motion_event(event: Event) -> None

Handle a joystick ball motion event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_enter_event
on_mouse_enter_event(event: Event) -> None

Handle a mouse enter event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_exit_event
on_mouse_exit_event(event: Event) -> None

Handle a mouse exit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_drag_down_event
on_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_left_mouse_drag_down_event
on_left_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_left_mouse_drag_up_event
on_left_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a left mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_middle_mouse_drag_down_event
on_middle_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag down event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_middle_mouse_drag_up_event
on_middle_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a middle mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_right_mouse_drag_down_event
on_right_mouse_drag_down_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag down event.

Args: event (pygame.event.Event): The event to handle. trigger (object | None): The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_right_mouse_drag_up_event
on_right_mouse_drag_up_event(event: Event, trigger: object | None) -> None

Handle a right mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object | None) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_drag_up_event
on_mouse_drag_up_event(event: Event) -> None

Handle a mouse drag up event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_chord_up_event
on_mouse_chord_up_event(event: Event, keys: list) -> None

Handle a mouse chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_chord_down_event
on_mouse_chord_down_event(event: Event, keys: list) -> None

Handle a mouse chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_key_chord_down_event
on_key_chord_down_event(event: Event, keys: list) -> None

Handle a key chord down event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_key_chord_up_event
on_key_chord_up_event(event: Event, keys: list) -> None

Handle a key chord up event.

Parameters:
  • event (Event) –

    The event to handle.

  • keys (list) –

    The keys that were pressed.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_quit_event
on_quit_event(event: Event) -> None

Handle a quit event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_active_event
on_active_event(event: Event) -> None

Handle an active event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_video_resize_event
on_video_resize_event(event: Event) -> None

Handle a video resize event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_video_expose_event
on_video_expose_event(event: Event) -> None

Handle a video expose event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_sys_wm_event
on_sys_wm_event(event: Event) -> None

Handle a sys wm event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_user_event
on_user_event(event: Event) -> None

Handle a user event.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.__str__
__str__() -> str

Returns a string representation of the sprite.

glitchygames.ui.InputDialog.load
load(filename: str) -> tuple[Surface, Rect, str]

Load a sprite from a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • tuple[Surface, Rect, str]

    A tuple containing the sprite's image, rect, and name.

Raises:
  • NoSectionError

    if the config file is missing a section.

  • NoOptionError

    if the config file is missing an option.

glitchygames.ui.InputDialog.inflate classmethod
inflate(width: int, height: int, pixels: list, color_map: dict) -> tuple[Surface, Rect]

Inflate a sprite from a list of pixels.

Parameters:
  • width (int) –

    the width of the sprite.

  • height (int) –

    the height of the sprite.

  • pixels (list) –

    the list of pixels.

  • color_map (dict) –

    the color map.

Returns:
  • tuple[Surface, Rect]

    A tuple containing the sprite's image and rect.

glitchygames.ui.InputDialog.save
save(filename: str) -> None

Save a sprite to a Bitmappy config file.

Parameters:
  • filename (str) –

    the filename of the Bitmappy config file.

Returns:
  • None

    None

glitchygames.ui.InputDialog.deflate
deflate() -> dict

Deflate a sprite to a Bitmappy config file.

Returns:
  • dict

    A dict containing the sprite's config.

glitchygames.ui.InputDialog.__init__
__init__(
    x: int,
    y: int,
    width: int,
    height: int,
    name: str | None = None,
    dialog_text: str = "Would you like to do a thing?",
    confirm_text: str = "Confirm",
    cancel_text: str = "Cancel",
    callbacks: Callable | None = None,
    parent: object = None,
    groups: LayeredDirty | None = None,
) -> None

Initialize an InputDialog.

Parameters:
  • x (int) –

    The x coordinate of the input dialog.

  • y (int) –

    The y coordinate of the input dialog.

  • width (int) –

    The width of the input dialog.

  • height (int) –

    The height of the input dialog.

  • name (str, default: None ) –

    The name of the input dialog.

  • dialog_text (str, default: 'Would you like to do a thing?' ) –

    The text to display in the dialog.

  • confirm_text (str, default: 'Confirm' ) –

    The text to display on the confirm button.

  • cancel_text (str, default: 'Cancel' ) –

    The text to display on the cancel button.

  • callbacks (Callable, default: None ) –

    The callbacks to call when events occur.

  • parent (object, default: None ) –

    The parent object.

  • groups (LayeredDirty | None, default: None ) –

    The sprite groups to add the sprite to.

Returns:
  • None

    None

glitchygames.ui.InputDialog.update_nested_sprites
update_nested_sprites() -> None

Update the nested sprites.

Returns:
  • None

    None

glitchygames.ui.InputDialog.update
update() -> None

Update the input dialog.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_confirm_event
on_confirm_event(event: Event, trigger: object) -> None

Handle confirm events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_cancel_event
on_cancel_event(event: Event, trigger: object) -> None

Handle cancel events.

Parameters:
  • event (Event) –

    The event to handle.

  • trigger (object) –

    The object that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_input_box_cancel_event
on_input_box_cancel_event(control: object) -> None

Handle input box cancel events.

Parameters:
  • control (object) –

    The control that triggered the event.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_input_box_submit_event
on_input_box_submit_event(event: Event) -> None

Handle input box submit events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_mouse_button_up_event
on_mouse_button_up_event(event: Event) -> None

Handle mouse button up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_key_up_event
on_key_up_event(event: Event) -> None

Handle key up events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

glitchygames.ui.InputDialog.on_key_down_event
on_key_down_event(event: Event) -> None

Handle key down events.

Parameters:
  • event (Event) –

    The event to handle.

Returns:
  • None

    None

Modules